com.ibm.tws.objects.model
Class ExternalDependency

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

public class ExternalDependency
extends java.lang.Object
implements TWSLink

External dependencies model associations of jobs and job streams with other jobs or job streams: an external dependency is a link to all versions of a referenced job or job stream. The collection of all versions of the same job stream is also called abstract job stream and is identified by an Identifier or by a JobStreamKey object with a null value for the validFrom field. Similarly, the concept of abstract job models the collection of all jobs with the same name and included in the same abstract job stream. External dependencies use the concept of abstract job stream and abstract job to identify the referenced predecessors, and must reference either an abstract job stream or an abstract job (that is, they cannot use both references at the same time).

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

abstractJobStreamKey If specified, must reference an existing abstract job stream
abstractJobKey If specified, must reference an existing abstract job
resolutionData See ResolutionData for constraints on this field

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

abstractJobStreamKey If specified, must reference an existing abstract job stream
abstractJobKey If specified, must reference an existing abstract job
The job name must be a number between 1 and 255
resolutionData See ResolutionData for constraints on this field
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, ResolutionData, Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          Copyright.
 
Constructor Summary
ExternalDependency()
          Creates an empty ExternalDependency.
ExternalDependency(Identifier id, JobKey key)
          Creates an ExternalDependency, specifying the identifier and key of the referenced abstract job.
ExternalDependency(Identifier id, JobStreamKey key)
          Creates an ExternalDependency, 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 ExternalDependency object are equal to those of the given one.
 Identifier getAbstractJobId()
          Returns the identifier of the referenced abstract job.
 JobKey getAbstractJobKey()
          Returns the key of the referenced abstract job.
 Identifier getAbstractJobStreamId()
          Returns the identifier of the referenced abstract job stream.
 JobStreamKey getAbstractJobStreamKey()
          Returns the key of the referenced abstract job stream.
 java.lang.String getDescription()
          Returns the description of the dependent job.
 Identifier getId()
          Returns the identifier of the abstract job or abstract job stream referenced by this dependency.
 PrintOption getReportPrintOption()
          Returns the LTP report print option.
 ResolutionData getResolutionData()
          Returns the criteria to be used for resolving the external dependency.
 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 ExternalDependency object.
 void setAbstractJobId(Identifier identifier)
          Sets the identifier of the referenced abstract job.
 void setAbstractJobKey(JobKey key)
          Sets the key of the referenced abstract job.
 void setAbstractJobStreamId(Identifier identifier)
          Sets the identifier of the referenced abstract job stream.
 void setAbstractJobStreamKey(JobStreamKey key)
          Sets the key of the referenced abstract job stream.
 void setDescription(java.lang.String value)
          Sets the description of the dependent job.
 void setReportPrintOption(PrintOption value)
          Sets the LTP report print option.
 void setResolutionData(ResolutionData data)
          Sets the criteria to be used for resolving the external dependency.
 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 ExternalDependency 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

ExternalDependency

public ExternalDependency()
Creates an empty ExternalDependency.


ExternalDependency

public ExternalDependency(Identifier id,
                          JobStreamKey key)
Creates an ExternalDependency, 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.

ExternalDependency

public ExternalDependency(Identifier id,
                          JobKey key)
Creates an ExternalDependency, 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 identifier of the abstract job or abstract job stream referenced by this dependency.

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

getAbstractJobStreamId

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

Returns:
The identifier of the referenced abstract job stream.

getAbstractJobStreamKey

public JobStreamKey getAbstractJobStreamKey()
Returns the key of the referenced abstract job stream.

Returns:
The key of the referenced abstract job stream.

getAbstractJobId

public Identifier getAbstractJobId()
Returns the identifier of the referenced abstract job.

Returns:
The identifier of the referenced abstract job.

getAbstractJobKey

public JobKey getAbstractJobKey()
Returns the key of the referenced abstract job.

Returns:
The key of the referenced abstract job.

getResolutionData

public ResolutionData getResolutionData()
Returns the criteria to be used for resolving the external dependency.

Returns:
The criteria to be used for resolving the external dependency.

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.

setAbstractJobStreamId

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

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

setAbstractJobStreamKey

public void setAbstractJobStreamKey(JobStreamKey key)
Sets the key of the referenced abstract job stream.

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

setAbstractJobId

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

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

setAbstractJobKey

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

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

setResolutionData

public void setResolutionData(ResolutionData data)
Sets the criteria to be used for resolving the external dependency.

Parameters:
data - The criteria to be used for resolving the external dependency.

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 ExternalDependency 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 ExternalDependency object.

Returns:
The object's hash code.

toString

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

Returns:
A text string including all ExternalDependency fields.


Copyright © 2005 IBM All Rights Reserved.