com.ibm.tws.objects.plan
Class JobStreamInPlanKey

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

public class JobStreamInPlanKey
extends FlowNodeInPlanKey

This object represents a job stream instance in plan external key, including fields used to identify a job stream in TWS external interfaces. Since a job stream is identified by its name, a validity date (the Scheduled Time) and a referenced workstation , this class includes a name attribute, a date attribute and a reference to a WorkstationInPlanKey object. Note that not in all situations a JobStreamInPlanKey can uniquely identify a JobStream there are situations in which name/workstation/Schedule Time are not enoght. In these situations you can identify each Job Stream instance by the JobStreamInPlan.internalIdentifier attribute, and use in all the APIs the Job Stream Identifier instead of filtering on name/workstation/Schedule Time

See Also:
JobStreamInPlan, Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          Copyright.
 
Constructor Summary
JobStreamInPlanKey()
          Creates an empty JobStreamKey.
JobStreamInPlanKey(java.lang.String name, WorkstationInPlanKey wrkKey, java.util.Date startTime)
          Creates a JobStreamKey with the specifed name, Workstation reference and scheduled time.
 
Method Summary
 boolean equals(java.lang.Object object)
          Returns true if all fields of this JobStreamInPlanKey object are equal to those of the given one.
 java.util.Date getStartTime()
          Returns the Scheduled Tome.
 WorkstationInPlanKey getWorkstationKey()
          Returns the reference to the Workstation key
 int hashCode()
          Returns a hash code for this JobStreamInPlanKey object.
 void setStartTime(java.util.Date date)
          Sets the Scheduled Time
 void setWorkstationKey(WorkstationInPlanKey key)
          Sets the Workstation key.
 java.lang.String toString()
          Returns a string representation of this JobStreamInPlanKey.
 
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

JobStreamInPlanKey

public JobStreamInPlanKey()
Creates an empty JobStreamKey.


JobStreamInPlanKey

public JobStreamInPlanKey(java.lang.String name,
                          WorkstationInPlanKey wrkKey,
                          java.util.Date startTime)
Creates a JobStreamKey with the specifed name, Workstation reference and scheduled time.

Parameters:
name - the JobStreamName
wrkKey - reference to a Workstation key
startTime - the job stream scheduled time.
Method Detail

equals

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

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

toString

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

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

getWorkstationKey

public WorkstationInPlanKey getWorkstationKey()
Returns the reference to the Workstation key

Returns:
the reference to the Workstation key

setWorkstationKey

public void setWorkstationKey(WorkstationInPlanKey key)
Sets the Workstation key.

Parameters:
key - the Workstation key.

getStartTime

public java.util.Date getStartTime()
Returns the Scheduled Tome.

Returns:
the Scheduled Tome.

setStartTime

public void setStartTime(java.util.Date date)
Sets the Scheduled Time

Parameters:
date - the Scheduled Time


Copyright © 2005 IBM All Rights Reserved.