com.ibm.tws.objects.plan
Class ExternalDependencyInPlan

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

public class ExternalDependencyInPlan
extends java.lang.Object
implements TWSLink

External dependencies plan associations of jobs and job streams with other jobs or job streams. This class represent the link between a Job (or Job Stream) instance and a Job (or Job Stream) instance. Note that if the link is between two jobs they cannot be in the same Job Stream instance.

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

jobStreamKey If specified, must reference an existing job stream
jobKey If specified, must reference an existing job
status The status of the dependency, the default is Unsatisfied.
Output Only.
satisfied Output Only
pending Output Only.
zombie Output Only.
internalStatus A FlowNodeInternalStatusType value.
Output Only.
taskData N/A
transportTime N/A
extendedName N/A
onCriticalPath N/A

See Also:
com.ibm.tws.objects.plan.types.InternalStatusType, Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          Copyright.
 
Constructor Summary
ExternalDependencyInPlan()
          Creates an empty ExternalDependencyInPlan.
ExternalDependencyInPlan(Identifier id, JobInPlanKey key)
          Creates an ExternalDependencyInPlan, specifying the identifier and key of the referenced abstract job.
ExternalDependencyInPlan(Identifier id, JobStreamInPlanKey key)
          Creates an ExternalDependencyInPlan, specifying the identifier and key of the referenced abstract job stream.
 
Method Summary
 boolean equals(java.lang.Object object)
          Returns true if all fields of this ExternalDependencyInPlan object are equal to those of the given one.
 Identifier getAbstractJobId()
          Deprecated.  
 JobInPlanKey getAbstractJobKey()
          Deprecated.  
 Identifier getAbstractJobStreamId()
          Deprecated.  
 JobStreamInPlanKey getAbstractJobStreamKey()
          Deprecated.  
 java.lang.String getExtendedName()
          Returns the extended name.
 Identifier getId()
          Returns the object's Identifiers
 FlowNodeInternalStatusType getInternalStatus()
          Returns the internal job status.
 Identifier getJobId()
          Returns the identifier of the referenced job.
 JobInPlanKey getJobKey()
          Returns the key of the referenced job.
 Identifier getJobStreamId()
          Returns the identifier of the referenced job stream.
 JobStreamInPlanKey getJobStreamKey()
          Returns the key of the referenced job stream.
 DependencyStatusType getStatus()
          Returns the status of the 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 ExternalDependencyInPlan object.
 boolean isOnCriticalPath()
          Returns the information if the predecessor/successor job is on the critical path z/OS only method
 boolean isPending()
          Returns true if the dependency is pending.
 boolean isSatisfied()
          Returns if this Dependency is a satisfied.
 boolean isZombie()
          Returns if this Dependency is a zombie.
 void setAbstractJobId(Identifier identifier)
          Deprecated.  
 void setAbstractJobKey(JobInPlanKey key)
          Deprecated.  
 void setAbstractJobStreamId(Identifier identifier)
          Deprecated.  
 void setAbstractJobStreamKey(JobStreamInPlanKey key)
          Deprecated.  
 void setExtendedName(java.lang.String extendedName)
          Sets the extended 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 setJobStreamId(Identifier identifier)
          Sets the identifier of the referenced job stream.
 void setJobStreamKey(JobStreamInPlanKey key)
          Sets the key of the referenced job stream.
 void setOnCriticalPath(boolean onCriticalPath)
          Sets on Critical Path z/OS only method.
 void setPending(boolean value)
          Sets if this Dependency is Pending For Internal Use Only.
 void setSatisfied(boolean b)
          Sets if this Dependency is satisfied.
 void setStatus(DependencyStatusType type)
          Sets the Dependency Status.
 void setTaskData(java.lang.String value)
          Sets the task data of the dependent job.
 void setTransportTime(int value)
          Sets the transport time.
 void setZombie(boolean b)
          Sets if this Dependency is a zombie.
 java.lang.String toString()
          Returns a string representation of this ExternalDependencyInPlan.
 
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

ExternalDependencyInPlan

public ExternalDependencyInPlan()
Creates an empty ExternalDependencyInPlan.


ExternalDependencyInPlan

public ExternalDependencyInPlan(Identifier id,
                                JobStreamInPlanKey key)
Creates an ExternalDependencyInPlan, specifying the identifier and key of the referenced abstract job stream.

Parameters:
id - The identifier of the referenced abstract job stream.
key - The key of the referenced abstract job stream.

ExternalDependencyInPlan

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

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

getId

public Identifier getId()
Returns the object's Identifiers

Specified by:
getId in interface TWSLink
Returns:
the object's Identifier
See Also:
TWSLink.getId()

getAbstractJobStreamId

public Identifier getAbstractJobStreamId()
Deprecated.  

Returns the identifier of the referenced abstract job stream.

Returns:
The identifier of the referenced abstract job stream.

getJobStreamId

public Identifier getJobStreamId()
Returns the identifier of the referenced job stream.

Returns:
The identifier of the referenced job stream.

getAbstractJobStreamKey

public JobStreamInPlanKey getAbstractJobStreamKey()
Deprecated.  

Returns the key of the referenced abstract job stream.

Returns:
The key of the referenced abstract job stream.

getJobStreamKey

public JobStreamInPlanKey getJobStreamKey()
Returns the key of the referenced job stream.

Returns:
The key of the referenced job stream.

getAbstractJobId

public Identifier getAbstractJobId()
Deprecated.  

Returns the identifier of the referenced abstract job.

Returns:
The identifier of the referenced abstract job.

getJobId

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

Returns:
The identifier of the referenced job.

getAbstractJobKey

public JobInPlanKey getAbstractJobKey()
Deprecated.  

Returns the key of the referenced abstract job.

Returns:
The key of the referenced abstract job.

getJobKey

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

Returns:
The key of the referenced job.

getStatus

public DependencyStatusType getStatus()
Returns the status of the Dependency. Valid Values are: Satisfied, Unsatisfied, Undecided.

Returns:
the Status of the Dependency.

isPending

public boolean isPending()
Returns true if the dependency is pending.

Returns:
true if the dependency is pending.

isOnCriticalPath

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

Returns:
Returns the onCriticalPath.

getTaskData

public java.lang.String getTaskData()
Returns the task data of the dependent job. z/OS only method.

Returns:
The task data of the dependent job.

getTransportTime

public int getTransportTime()
Returns the transport time. z/OS only method.

Returns:
The transport time.

getInternalStatus

public FlowNodeInternalStatusType getInternalStatus()
Returns the internal job status.

Returns:
The internal status.
See Also:
FlowNodeInternalStatusType

getExtendedName

public java.lang.String getExtendedName()
Returns the extended name. z/OS Only method.

Returns:
Returns the extendedName.

setAbstractJobStreamId

public void setAbstractJobStreamId(Identifier identifier)
Deprecated.  

Sets the identifier of the referenced abstract job stream.

Parameters:
identifier - The identifier of the referenced abstract job stream.

setJobStreamId

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

Parameters:
identifier - The identifier of the referenced job stream.

setAbstractJobStreamKey

public void setAbstractJobStreamKey(JobStreamInPlanKey key)
Deprecated.  

Sets the key of the referenced abstract job stream.

Parameters:
key - The key of the referenced abstract job stream.

setJobStreamKey

public void setJobStreamKey(JobStreamInPlanKey key)
Sets the key of the referenced job stream.

Parameters:
key - The key of the referenced job stream.

setAbstractJobId

public void setAbstractJobId(Identifier identifier)
Deprecated.  

Sets the identifier of the referenced abstract job.

Parameters:
identifier - The identifier of the referenced abstract job.

setJobId

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

Parameters:
identifier - The identifier of the referenced job.

setAbstractJobKey

public void setAbstractJobKey(JobInPlanKey key)
Deprecated.  

Sets the key of the referenced abstract job.

Parameters:
key - The key of the referenced abstract 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)
Sets the Dependency Status. For Internal Use Only.

Parameters:
type - the Dependency Status.

setPending

public void setPending(boolean value)
Sets if this Dependency is Pending For Internal Use Only.

Parameters:
value - true if this Dependency is pending, false otherwise.

setOnCriticalPath

public void setOnCriticalPath(boolean onCriticalPath)
Sets on Critical Path z/OS only method.

Parameters:
onCriticalPath - The onCriticalPath to set.

setTaskData

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

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

setTransportTime

public void setTransportTime(int value)
Sets the transport time. z/OS only 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.

equals

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

Returns:
The object's hash code.

toString

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

Returns:
A text string including all ExternalDependencyInPlan fields.

isZombie

public boolean isZombie()
Returns if this Dependency is a zombie.

Returns:
true if this Dependency is a zombie, false otherwise.

setZombie

public void setZombie(boolean b)
Sets if this Dependency is a zombie. For internal use only.

Parameters:
b - true if this Dependency is a zombie, false otherwise.

isSatisfied

public boolean isSatisfied()
Returns if this Dependency is a satisfied.

Returns:
true if this Dependency is a satisfied, false otherwise.

setSatisfied

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

Parameters:
b - true if this Dependency is satisfied, false otherwise.

setExtendedName

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

Parameters:
extendedName - The extendedName to set.


Copyright © 2005 IBM All Rights Reserved.