com.ibm.tws.objects.model
Class FlowTargetKey

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

public class FlowTargetKey
extends java.lang.Object
implements TWSKey

This object represents a workstation or workstation class external key, including fields used to identify a workstation or a workstation class in TWS external interfaces. Since a workstation cannot have the same name of a workstation class, the only attribute of this class, which is called name, uniquely identifies either a workstation or a workstation class.

See Also:
FlowTarget, Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          Copyright.
 
Constructor Summary
FlowTargetKey()
          Creates an empty FlowTargetKey.
FlowTargetKey(java.lang.String flowTargetName)
          Creates a FlowTargetKey with the specified name.
 
Method Summary
 boolean equals(java.lang.Object object)
          Returns true if all fields of this FlowTargetKey object are equal to those of the given one.
 java.lang.String getName()
          Returns the workstation or workstation class name.
 int hashCode()
          Returns a hash code for this FlowTargetKey object.
static FlowTargetKey parseKey(java.lang.String key)
          Parses data from the specified string and creates a new FlowTargetKey.
 void setCurrentRole(boolean asWorkstation)
          Sets the current role, used only by the toString() method to format the key string.
 void setName(java.lang.String value)
          Sets the workstation or workstation class name.
 java.lang.String toString()
          Returns a string representation of this FlowTargetKey object as a workstation key.
 java.lang.String toString(boolean asWorkstation)
          Returns a string representation of this FlowTargetKey object as a workstation or workstation class key.
 
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

FlowTargetKey

public FlowTargetKey()
Creates an empty FlowTargetKey.


FlowTargetKey

public FlowTargetKey(java.lang.String flowTargetName)
Creates a FlowTargetKey with the specified name.

Parameters:
flowTargetName - The workstation or workstation class name.
Method Detail

parseKey

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

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

getName

public java.lang.String getName()
Returns the workstation or workstation class name.

Specified by:
getName in interface TWSKey
Returns:
The workstation or workstation class name.

setName

public void setName(java.lang.String value)
Sets the workstation or workstation class name.

Parameters:
value - The workstation or workstation class name.

setCurrentRole

public void setCurrentRole(boolean asWorkstation)
Sets the current role, used only by the toString() method to format the key string.

Parameters:
asWorkstation - True if this key must be represented as a workstation key (false for a workstation class key).

equals

public boolean equals(java.lang.Object object)
Returns true if all fields of this FlowTargetKey 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 FlowTargetKey object.

Returns:
The object's hash code.

toString

public java.lang.String toString()
Returns a string representation of this FlowTargetKey object as a workstation key.

Returns:
A text string including all FlowTargetKey fields.

toString

public java.lang.String toString(boolean asWorkstation)
Returns a string representation of this FlowTargetKey object as a workstation or workstation class key.

Parameters:
asWorkstation - True if this key must be represented as a workstation key (false for a workstation class key).
Returns:
A text string including all FlowTargetKey fields.


Copyright © 2005 IBM All Rights Reserved.