com.ibm.tws.objects.model
Class JobKey

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

public class JobKey
extends FlowNodeKey

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

See Also:
Job, Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          Copyright.
 
Constructor Summary
JobKey()
          Creates an empty JobKey.
JobKey(java.lang.String jobName, JobStreamKey jstKey)
          Creates a JobKey with the specified name and job stream key.
 
Method Summary
 boolean equals(java.lang.Object object)
          Returns true if all fields of this JobKey object are equal to those of the given one.
 JobStreamKey getJobStreamKey()
          Returns the key of the job stream that includes this job.
 int hashCode()
          Returns a hash code for this JobKey object.
static JobKey parseKey(java.lang.String key)
          Parses data from the specified string and creates a new JobKey.
 void setJobStreamKey(JobStreamKey jstKey)
          Sets the key of the job stream that includes this job.
 java.lang.String toString()
          Returns a string representation of this JobKey object.
 
Methods inherited from class com.ibm.tws.objects.model.FlowNodeKey
getName, setName
 
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

JobKey

public JobKey()
Creates an empty JobKey.


JobKey

public JobKey(java.lang.String jobName,
              JobStreamKey jstKey)
Creates a JobKey with the specified name and job stream key.

Parameters:
jobName - The job name.
jstKey - The key of the job stream that includes this job.
Method Detail

parseKey

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

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

getJobStreamKey

public JobStreamKey getJobStreamKey()
Returns the key of the job stream that includes this job.

Returns:
The key of the job stream that includes this job.

setJobStreamKey

public void setJobStreamKey(JobStreamKey jstKey)
Sets the key of the job stream that includes this job.

Parameters:
jstKey - The key of the job stream that includes this job.

equals

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

Overrides:
equals in class FlowNodeKey
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 JobKey object.

Overrides:
hashCode in class FlowNodeKey
Returns:
The object's hash code.

toString

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

Returns:
A text string including all JobKey fields.


Copyright © 2005 IBM All Rights Reserved.