com.ibm.tws.objects.plan
Class JobInPlanKey

java.lang.Object
  extended bycom.ibm.tws.objects.plan.FlowNodeInPlanKey
      extended bycom.ibm.tws.objects.plan.JobInPlanKey
All Implemented Interfaces:
java.io.Serializable, TWSKey

public class JobInPlanKey
extends FlowNodeInPlanKey

This object represents a job instance in plan 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:
JobInPlan, Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          Copyright.
 
Constructor Summary
JobInPlanKey()
          Creates an empty JobInPlanKey.
JobInPlanKey(java.lang.String jobName, JobStreamInPlanKey jstKey)
          Creates a JobInPlanKey with the specified name and job stream key.
 
Method Summary
 boolean equals(java.lang.Object object)
          Returns true if all fields of this JobInPlanKey object are equal to those of the given one.
 JobStreamInPlanKey getJobStreamKey()
          Returns the key of the Job Stream to which this Job belongs
 int hashCode()
          Returns a hash code for this JobInPlanKey object.
 void setJobStreamKey(JobStreamInPlanKey key)
          Sets the key of the Job Stream to which this Job belongs
 java.lang.String toString()
          Returns a string representation of this JobInPlanKey.
 
Methods inherited from class com.ibm.tws.objects.plan.FlowNodeInPlanKey
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

JobInPlanKey

public JobInPlanKey()
Creates an empty JobInPlanKey.


JobInPlanKey

public JobInPlanKey(java.lang.String jobName,
                    JobStreamInPlanKey jstKey)
Creates a JobInPlanKey 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

getJobStreamKey

public JobStreamInPlanKey getJobStreamKey()
Returns the key of the Job Stream to which this Job belongs

Returns:
the Job Stream key.

setJobStreamKey

public void setJobStreamKey(JobStreamInPlanKey key)
Sets the key of the Job Stream to which this Job belongs

Parameters:
key - the Job Stream key to set.

equals

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

Overrides:
equals in class FlowNodeInPlanKey
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 JobInPlanKey object.

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

toString

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

Overrides:
toString in class FlowNodeInPlanKey
Returns:
A text string including all JobInPlanKey fields.


Copyright © 2005 IBM All Rights Reserved.