com.ibm.tws.objects.model
Class JobDefinitionKey

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

public class JobDefinitionKey
extends java.lang.Object
implements TWSKey

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

See Also:
JobDefinition, Serialized Form

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

JobDefinitionKey

public JobDefinitionKey()
Creates an empty JobDefinitionKey.


JobDefinitionKey

public JobDefinitionKey(java.lang.String jobDefinitionName,
                        FlowTargetKey trgKey)
Creates a JobDefinitionKey with the specified name and workstation or workstation class key.

Parameters:
jobDefinitionName - The job definition name.
trgKey - The key of the workstation or workstation class referenced by this job definition.
Method Detail

parseKey

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

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

getName

public java.lang.String getName()
Returns the job definition name.

Specified by:
getName in interface TWSKey
Returns:
The job definition name.

getFlowTargetKey

public FlowTargetKey getFlowTargetKey()
Returns the key of the workstation or workstation class referenced by this job definition.

Returns:
The key of the workstation or workstation class referenced by this job definition.

setName

public void setName(java.lang.String value)
Sets the job definition name.

Parameters:
value - The job definition name.

setFlowTargetKey

public void setFlowTargetKey(FlowTargetKey trgKey)
Sets the key of the workstation or workstation class referenced by this job definition.

Parameters:
trgKey - The key of the workstation or workstation class referenced by this job definition.

equals

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

Returns:
The object's hash code.

toString

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

Returns:
A text string including all JobDefinitionKey fields.


Copyright © 2005 IBM All Rights Reserved.