com.ibm.tws.objects.plan
Class InternalDependencyInPlan

java.lang.Object
  extended bycom.ibm.tws.objects.plan.InternalDependencyInPlan
All Implemented Interfaces:
java.io.Serializable, TWSLink

public class InternalDependencyInPlan
extends java.lang.Object
implements TWSLink

Internal dependencies plan associations of jobs with other jobs. This class represent the link between a Job instance and another Job instance. Note that the two linked jobs must be in the same Job Stream instance.

The following syntax validation constraints must be met on InternalDependencyInPlan objects:

jobKey Reference to an existing job
status The status of the dependency, the default is Unsatisfied.
Output Only.
satisfied Output Only.
internalStatus A FlowNodeInternalStatusType value
Output Only.
taskData N/A
transportTime N/A
extendedName N/A
onCriticalPath N/A

See Also:
Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          Copyright
 
Constructor Summary
InternalDependencyInPlan()
          Creates an empty InternalDependencyInPlan.
InternalDependencyInPlan(Identifier id, JobInPlanKey key)
          Creates an InternalDependencyInPlan, specifying the identifier and key of the referenced job.
 
Method Summary
 boolean equals(java.lang.Object object)
          Returns true if all fields of this InternalDependencyInPlan object are equal to those of the given one.
 java.lang.String getExtendedName()
          Returns the extended name.
 Identifier getId()
          Returns the Identifier of the referenced job
 FlowNodeInternalStatusType getInternalStatus()
          Retrurns the internal job status.
 Identifier getJobId()
          Returns the identifier of the referenced job.
 JobInPlanKey getJobKey()
          Returns the key of the referenced job.
 DependencyStatusType getStatus()
          Return the status of this dependency.
 java.lang.String getTaskData()
          Returns the task data of the dependent job.
 int getTransportTime()
          Returns the transport time.
 int hashCode()
          Returns a hash code for this InternalDependencyInPlan object.
 boolean isOnCriticalPath()
          Returns the information if the predecessor/successor job is on the critical path It is a z/OS specific method.
 boolean isSatisfied()
          Returns true if this dependency is satisfied, false otherwise.
 void setExtendedName(java.lang.String extendedName)
          Sets the extendend name.
 void setInternalStatus(FlowNodeInternalStatusType value)
          Sets the internal status.
 void setJobId(Identifier identifier)
          Sets the identifier of the referenced job.
 void setJobKey(JobInPlanKey key)
          Sets the key of the referenced job.
 void setOnCriticalPath(boolean onCriticalPath)
          Set if the predecessor/successor job is on the critical path It is a z/OS specific method.
 void setSatisfied(boolean b)
          Sets if this dependency is satisfied or not.
 void setStatus(DependencyStatusType type)
          Set the status of this dependency.
 void setTaskData(java.lang.String value)
          Sets the task data of the dependent job.
 void setTransportTime(int value)
          Sets the transport time.
 java.lang.String toString()
          Returns a string representation of this InternalDependencyInPlan.
 
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

InternalDependencyInPlan

public InternalDependencyInPlan()
Creates an empty InternalDependencyInPlan.


InternalDependencyInPlan

public InternalDependencyInPlan(Identifier id,
                                JobInPlanKey key)
Creates an InternalDependencyInPlan, specifying the identifier and key of the referenced job.

Parameters:
id - The identifier of the referenced job.
key - The key of the referenced job.
Method Detail

getId

public Identifier getId()
Returns the Identifier of the referenced job

Specified by:
getId in interface TWSLink
Returns:
the Identifier of the referenced job
See Also:
TWSLink.getId()

getJobId

public Identifier getJobId()
Returns the identifier of the referenced job.

Returns:
The identifier of the referenced job.

getJobKey

public JobInPlanKey getJobKey()
Returns the key of the referenced job.

Returns:
The key of the referenced job.

getStatus

public DependencyStatusType getStatus()
Return the status of this dependency. Valid values are: Satisfied, Unsatisfied, Undecided

Returns:
the status of this dependency.

getTaskData

public java.lang.String getTaskData()
Returns the task data of the dependent job. It is a z/OS specific method.

Returns:
The task data of the dependent job.

getTransportTime

public int getTransportTime()
Returns the transport time. It is a z/OS specific method.

Returns:
The transport time.

getInternalStatus

public FlowNodeInternalStatusType getInternalStatus()
Retrurns the internal job status.

Returns:
The internal status.

isOnCriticalPath

public boolean isOnCriticalPath()
Returns the information if the predecessor/successor job is on the critical path It is a z/OS specific method.

Returns:
Returns the onCriticalPath.

getExtendedName

public java.lang.String getExtendedName()
Returns the extended name. It is a z/OS specific method.

Returns:
Returns the extended name onCriticalPath.

setJobId

public void setJobId(Identifier identifier)
Sets the identifier of the referenced job.

Parameters:
identifier - The identifier of the referenced job.

setJobKey

public void setJobKey(JobInPlanKey key)
Sets the key of the referenced job.

Parameters:
key - The key of the referenced job.

setStatus

public void setStatus(DependencyStatusType type)
Set the status of this dependency. For internal use only

Parameters:
type -

setTaskData

public void setTaskData(java.lang.String value)
Sets the task data of the dependent job. It is a z/OS specific method.

Parameters:
value - The task data of the dependent job.

setTransportTime

public void setTransportTime(int value)
Sets the transport time. It is a z/OS specific method.

Parameters:
value - The transport time.

setInternalStatus

public void setInternalStatus(FlowNodeInternalStatusType value)
Sets the internal status. For internal use only.

Parameters:
value - The internal status.

setOnCriticalPath

public void setOnCriticalPath(boolean onCriticalPath)
Set if the predecessor/successor job is on the critical path It is a z/OS specific method.

Parameters:
onCriticalPath - The new value to set.

equals

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

Returns:
The object's hash code.

toString

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

Returns:
A text string including all InternalDependencyInPlan fields.

isSatisfied

public boolean isSatisfied()
Returns true if this dependency is satisfied, false otherwise.

Returns:
true if this dependency is satisfied, false otherwise.

setSatisfied

public void setSatisfied(boolean b)
Sets if this dependency is satisfied or not. For internal use only.

Parameters:
b -

setExtendedName

public void setExtendedName(java.lang.String extendedName)
Sets the extendend name. z/OS specific method.

Parameters:
extendedName - The new value to set.


Copyright © 2005 IBM All Rights Reserved.