com.ibm.tws.objects.model
Class WindowsUserKey

java.lang.Object
  extended bycom.ibm.tws.objects.model.WindowsUserKey
All Implemented Interfaces:
java.io.Serializable, TWSKey

public class WindowsUserKey
extends java.lang.Object
implements TWSKey

This object represents a Windows user external key, including fields used to identify a Windows user in TWS external interfaces. Since a Windows user is identified by its name and by a referenced workstation, this class includes a name attribute and a reference to a FlowTargetKey object, to externally identify the referenced workstation.

See Also:
WindowsUser, Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          Copyright.
 
Constructor Summary
WindowsUserKey()
          Creates an empty WindowsUserKey.
WindowsUserKey(java.lang.String windowsUserName, FlowTargetKey wksKey)
          Creates a WindowsUserKey with the specified name and workstation key.
 
Method Summary
 boolean equals(java.lang.Object object)
          Returns true if all fields of this WindowsUserKey object are equal to those of the given one.
 java.lang.String getName()
          Returns the windows user name.
 FlowTargetKey getWorkstationKey()
          Returns the key of the workstation referenced by this windows user.
 int hashCode()
          Returns a hash code for this WindowsUserKey object.
static WindowsUserKey parseKey(java.lang.String key)
          Parses data from the specified string and creates a new WindowsUserKey.
 void setName(java.lang.String value)
          Sets the windows user name.
 void setWorkstationKey(FlowTargetKey wksKey)
          Sets the key of the workstation referenced by this windows user.
 java.lang.String toString()
          Returns a string representation of this WindowsUserKey object.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
Copyright.

Constructor Detail

WindowsUserKey

public WindowsUserKey()
Creates an empty WindowsUserKey.


WindowsUserKey

public WindowsUserKey(java.lang.String windowsUserName,
                      FlowTargetKey wksKey)
Creates a WindowsUserKey with the specified name and workstation key.

Parameters:
windowsUserName - The windows user name.
wksKey - The key of the workstation referenced by this windows user.
Method Detail

parseKey

public static WindowsUserKey parseKey(java.lang.String key)
Parses data from the specified string and creates a new WindowsUserKey.

Parameters:
key - The string containing key data.
Returns:
A new WindowsUserKey, or null if the string does not contain a valid key.

getName

public java.lang.String getName()
Returns the windows user name.

Specified by:
getName in interface TWSKey
Returns:
The windows user name.

getWorkstationKey

public FlowTargetKey getWorkstationKey()
Returns the key of the workstation referenced by this windows user.

Returns:
The key of the workstation referenced by this windows user.

setName

public void setName(java.lang.String value)
Sets the windows user name.

Parameters:
value - The windows user name.

setWorkstationKey

public void setWorkstationKey(FlowTargetKey wksKey)
Sets the key of the workstation referenced by this windows user.

Parameters:
wksKey - The key of the workstation referenced by this windows user.

equals

public boolean equals(java.lang.Object object)
Returns true if all fields of this WindowsUserKey object are equal to those of the given one.

Parameters:
object - The object to be compared with this one.
Returns:
True if this object equals to the given one.

hashCode

public int hashCode()
Returns a hash code for this WindowsUserKey object.

Returns:
The object's hash code.

toString

public java.lang.String toString()
Returns a string representation of this WindowsUserKey object.

Returns:
A text string including all WindowsUserKey fields.


Copyright © 2005 IBM All Rights Reserved.