com.ibm.tws.objects.model
Class InternalDependency

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

public class InternalDependency
extends java.lang.Object
implements TWSLink

This object models an internal dependency of a job in a job stream from another job in the same job stream.

The following syntax validation constraints must be met on InternalDependency objects in distributed environment:

jobKey Must reference an existing job in the same job stream

The following syntax validation constraints must be met on InternalDependency objects in z/OS environment:

jobKey Must reference an existing job in the same job stream
The job name must be a number between 1 and 255
taskData This is a read-only field
transportTime An amount of time, expressed in milliseconds
Represents an estimated time for work to get to this workstation from the preceding one
Optional: use TypeUtility.NULL_OFFSET to specify null values
reportPrintOption One of the values exposed by the PrintOption class
Default value is PrintOption.ALWAYS
description Not longer than 50 characters

See Also:
PrintOption, Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          Copyright.
 
Constructor Summary
InternalDependency()
          Creates an empty InternalDependency.
InternalDependency(Identifier id)
          Creates an InternalDependency, specifying the identifier of the referenced job.
InternalDependency(Identifier id, JobKey key)
          Creates an InternalDependency, specifying the identifier and key of the referenced job.
InternalDependency(JobKey key)
          Creates an InternalDependency, specifying the key of the referenced job.
 
Method Summary
 boolean equals(java.lang.Object object)
          Returns true if all fields of this InternalDependency object are equal to those of the given one.
 java.lang.String getDescription()
          Returns the description of the dependent job.
 Identifier getId()
          Returns the identifier of the job referenced by this dependency.
 Identifier getJobId()
          Returns the identifier of the referenced job.
 JobKey getJobKey()
          Returns the key of the referenced job.
 PrintOption getReportPrintOption()
          Returns the LTP report print option.
 java.lang.String getTaskData()
          Returns the task data of the dependent job.
 long getTransportTime()
          Returns the transport time.
 int hashCode()
          Returns a hash code for this InternalDependency object.
 void setDescription(java.lang.String value)
          Sets the description of the dependent job.
 void setJobId(Identifier id)
          Sets the identifier of the referenced job.
 void setJobKey(JobKey key)
          Sets the key of the referenced job.
 void setReportPrintOption(PrintOption value)
          Sets the LTP report print option.
 void setTaskData(java.lang.String value)
          Sets the task data of the dependent job.
 void setTransportTime(long value)
          Sets the transport time.
 java.lang.String toString()
          Returns a string representation of this InternalDependency object.
 
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

InternalDependency

public InternalDependency()
Creates an empty InternalDependency.


InternalDependency

public InternalDependency(Identifier id)
Creates an InternalDependency, specifying the identifier of the referenced job.

Parameters:
id - The identifier of the referenced job.

InternalDependency

public InternalDependency(JobKey key)
Creates an InternalDependency, specifying the key of the referenced job.

Parameters:
key - The key of the referenced job.

InternalDependency

public InternalDependency(Identifier id,
                          JobKey key)
Creates an InternalDependency, 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 job referenced by this dependency.

Specified by:
getId in interface TWSLink
Returns:
The identifier of the job referenced by this dependency.

getJobId

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

Returns:
The identifier of the referenced job.

getJobKey

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

Returns:
The key of the referenced job.

getTaskData

public java.lang.String getTaskData()
Returns the task data of the dependent job.

Returns:
The task data of the dependent job.

getDescription

public java.lang.String getDescription()
Returns the description of the dependent job.

Returns:
The description of the dependent job.

getTransportTime

public long getTransportTime()
Returns the transport time.

Returns:
The transport time.

getReportPrintOption

public PrintOption getReportPrintOption()
Returns the LTP report print option.

Returns:
The LTP report print option.

setJobId

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

Parameters:
id - The identifier of the referenced job.

setJobKey

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

Parameters:
key - The key of the referenced job.

setTaskData

public void setTaskData(java.lang.String value)
Sets the task data of the dependent job.

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

setDescription

public void setDescription(java.lang.String value)
Sets the description of the dependent job.

Parameters:
value - The description of the dependent job.

setTransportTime

public void setTransportTime(long value)
Sets the transport time.

Parameters:
value - The transport time.

setReportPrintOption

public void setReportPrintOption(PrintOption value)
Sets the LTP report print option.

Parameters:
value - The LTP report print option.

equals

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

Returns:
The object's hash code.

toString

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

Returns:
A text string including all InternalDependency fields.


Copyright © 2005 IBM All Rights Reserved.