com.ibm.tws.objects.plan
Class FlowNodeInPlan

java.lang.Object
  extended bycom.ibm.tws.objects.plan.FlowNodeInPlan
All Implemented Interfaces:
java.io.Serializable, TWSHeader, TWSObject
Direct Known Subclasses:
JobInPlan, JobStreamInPlan

public abstract class FlowNodeInPlan
extends java.lang.Object
implements TWSObject, TWSHeader

This is a base class for JobInPlan and JobStreamInPlan.

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

name Always required.
See JobStreamInPlan and JobInPlan for constraints on this field
description N/A
cpuTime This is an output parameter. It cannot be changed.
elapsedTime This is an output parameter. It cannot be changed.
estimatedDuration This is an output parameter. It cannot be changed.
numDependencies This is an output parameter. It cannot be changed.
origPriority This is an output parameter. It cannot be changed.
priority Allowed range is 0-101. Default value is 10.
recordNumber For Internal Use Only
numberOfJobDependencies This is an output parameter. It cannot be changed.
numberOfJobStreamDependencies This is an output parameter. It cannot be changed.
numberOfInternetworkDependencies This is an output parameter. It cannot be changed.
numberOfFileDependencies This is an output parameter. It cannot be changed.
numberOfResourceDependencies This is an output parameter. It cannot be changed.
numberOfPromptDependencies This is an output parameter. It cannot be changed.
internalStatus One of the values exposed by the FlowNodeInternalStatusType.
class, excluding the ones starting with FLOW_NODE_ZOSSTATUS_.
This is an output parameter. It cannot be changed.
status One of the values exposed by the FlowNodeStatusType class.
This is an output parameter. It cannot be changed.
monitored Monitoring flag. Default value is false.
This flag is ignored if the version of Tivoli Workload Scheduler for zOS is prior to 8.1.
timeZone This is an output parameter. It cannot be changed.
timeStarted This is an output parameter. It cannot be changed.
timeRestrictions See TimeRestrictions for constraints on this field.
Even if no Time Restrictions are present this object is allocated but empty.
externalDependencies See ExternalDependencyInPlan for constraints on this field.
Even if no External Dependency are present the List is allocated but empty.
interNetworkDependencies See InternetworkDependencyInPlan for constraints on this field.
Even if no Internetwork Dependency are present the List is allocated but empty.
promptDependencies See PromptDependencyInPlan for constraints on this field.
Even if no Prompt Dependency are present the List is allocated but empty.
fileDependencies See FileDependencyInPlan for constraints on this field.
Even if no File Dependency are present the List is allocated but empty.
resourceDependencies See ResourceDependecyInPlan for constraints on this field.
Even if no Resource Dependency are present the List is allocated but empty.

The following syntax validation constraints must be met on FlowNodeInPlan objects in zOS environment:

name Always required.
See JobStreamInPlan and JobInPlan for constraints on this field
description Not longer than 24 characters
cpuTime N/A
elapsedTime In JobStreamInPlan: Actual Completition - Actual Arrival.
In JobInPlan: Actual Duration.
In recovery JobInPlan: Recovery Job Duration.
estimatedDuration N/A
numDependencies N/A
origPriority N/A
priority Allowed range is from 1 to 9
recordNumber N/A
numberOfJobDependencies N/A
numberOfJobStreamDependencies N/A
numberOfInternetworkDependencies N/A
numberOfFileDependencies N/A
numberOfResourceDependencies N/A
numberOfPromptDependencies N/A
internalStatus One of the values exposed by the FlowNodeInternalStatusType.
class, with name starting with FLOW_NODE_ZOSSTATUS_.
status One of the values exposed by the FlowNodeStatusType class.
monitored Monitoring flag. Default value is false.
This flag is ignored if the version of Tivoli Workload Scheduler for zOS is prior to 8.1.
timeZone N/A
timeStarted This is an output parameter. It cannot be changed.
timeRestrictions See TimeRestrictions for constraints on this field.
externalDependencies Used only in JobInPlan
interNetworkDependencies N/A
promptDependencies N/A
fileDependencies N/A
resourceDependencies Used only in JobInPlan>

See Also:
TimeRestrictions, FlowNodeInternalStatusType, FlowNodeStatusType, JobStreamInPlan, JobInPlan, ResourceDependencyInPlan, FileDependencyInPlan, PromptDependencyInPlan, ExternalDependencyInPlan, InternetworkDependencyInPlan, Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          Copyright.
 
Constructor Summary
protected FlowNodeInPlan()
          Creates an empty FlowNode.
protected FlowNodeInPlan(FlowNodeInPlanKey key)
          Constructor For internal use only.
protected FlowNodeInPlan(Identifier id)
          Constructor For internal use only.
protected FlowNodeInPlan(Identifier id, FlowNodeInPlanKey key)
          Constructor For internal use only.
 
Method Summary
 boolean equals(java.lang.Object object)
          Returns true if all fields of this FlowNodeInPlan object are equal to those of the given one.
 long getCpuTime()
          Returns the CPU time
 java.lang.String getDescription()
          Returns the Flow Node description.
 long getElapsedTime()
          Returns The Flow Node Real Duration.
 long getEstimatedDuration()
          Returns The Flow Node Estimated Duration.
 java.util.List getExternalDependencies()
          Returns the List of ExternalDependencyInPlan.
 java.util.List getFileDependencies()
          Returns the List of FileDependencyInPlan.
 Identifier getId()
          Returns the object identifier.
 FlowNodeInternalStatusType getInternalStatus()
          Returns the Flow Node Internal Status.
 java.util.List getInterNetworkDependencies()
          Returns the List of InternetworkDependencyInPlan.
 FlowNodeInPlanKey getKey()
          Returns the FlowNodeInPlanKey wrapped by this FlowNodeInPlan object.
 java.lang.String getName()
          Returns the Flow Node name.
 int getNumberOfFileDependencies()
          Returns The Number of File Dependencies
 int getNumberOfInternetworkDependencies()
          Returns The Number of Internetwork Dependencies
 int getNumberOfJobDependencies()
          Returns The Number of Job Dependencies
 int getNumberOfJobStreamDependencies()
          Returns The Number of Job Stream Dependencies
 int getNumberOfPromptDependencies()
          Returns The Number of Prompt Dependencies
 int getNumberOfResourceDependencies()
          Returns The Number of Resource Dependencies
 int getNumDependencies()
          Returns the Number of Dependencies
 TWSKey getObjectKey()
          Returns the object key.
 int getOrigPriority()
          Returns the Flow Node original priority.
 int getPriority()
          Returns the Flow Node priority.
 java.util.List getPromptDependencies()
          Returns the List of PromptDependencyInPlan.
 long getRecordNumber()
          Returns the Flow Node Record Number in the Symphony File For Internal Use Only
 java.util.List getResourceDependencies()
          Returns the List of ResourceDependencyInPlan.
 FlowNodeStatusType getStatus()
          Returns the status of the Flow Node.
 TimeRestrictions getTimeRestrictions()
          Returns the Flow Node TimeRestrictions
 java.util.Date getTimeStarted()
          Returns the Date this Flow Node really Started.
 java.lang.String getTimeZone()
          Returns the Flow Node Timezone
 int hashCode()
          Returns a hash code for this FlowNodeInPlan object.
 boolean isMonitored()
          Returns if this Flow Node is monitored or not.
 void setCpuTime(long l)
          Sets the CPU time For internal use only.
 void setDescription(java.lang.String string)
          Sets the Description of this Flow node.
 void setElapsedTime(long l)
          Sets the Real Flow Node Duration.
 void setEstimatedDuration(long l)
          Sets the Estimated Flow Node Duration For internal use only.
 void setId(Identifier identifier)
          Sets the Flow Node Identifier.
 void setInternalStatus(FlowNodeInternalStatusType internalStatus)
          Sets the Flow Node Internal Status.
 void setKey(FlowNodeInPlanKey flowNodeKey)
          Sets the FlowNodeInPlanKey to be wrapped by this FlowNodeInPlan object.
 void setMonitored(boolean b)
          Sets if this Flow Node is monitored or not.
 void setName(java.lang.String value)
          Sets the Flow Node name.
 void setNumberOfFileDependencies(int i)
          Sets The Number of File Dependencies.
 void setNumberOfInternetworkDependencies(int i)
          Sets The Number of Internetwork Dependencies.
 void setNumberOfJobDependencies(int i)
          Sets The Number of Job Dependencies.
 void setNumberOfJobStreamDependencies(int i)
          Sets The Number of Job Stream Dependencies.
 void setNumberOfPromptDependencies(int i)
          Sets The Number of Prompt Dependencies.
 void setNumberOfResourceDependencies(int i)
          Sets The Number of Resource Dependencies.
 void setNumDependencies(int i)
          Sets the number of dependencies
 void setOrigPriority(int value)
          Sets the Flow Node original priority.
 void setPriority(int value)
          Sets the Flow Node priority.
 void setRecordNumber(long l)
          Sets the Flow Node Record Number in the Symphony File For Internal Use Only
 void setStatus(FlowNodeStatusType type)
          Sets the status of the Flow Node For internal use only.
 void setTimeRestrictions(TimeRestrictions restrictions)
          Sets the Flow Node Time Restriction.
 void setTimeStarted(java.util.Date l)
          Sets the Real Start Time For internal use only.
 void setTimeZone(java.lang.String string)
          Sets the Flow Node Timezone For internal use only.
 java.lang.String toString()
          Returns a string representation of this FlowNodeInPlan.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.ibm.tws.objects.TWSObject
getLockData, getModifyData, getObjectHeader
 
Methods inherited from interface com.ibm.tws.objects.TWSHeader
getLockData, getModifyData
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
Copyright.

Constructor Detail

FlowNodeInPlan

protected FlowNodeInPlan()
Creates an empty FlowNode. For internal use only.


FlowNodeInPlan

protected FlowNodeInPlan(Identifier id)
Constructor For internal use only.

Parameters:
id - The Flow node Identifier.

FlowNodeInPlan

protected FlowNodeInPlan(FlowNodeInPlanKey key)
Constructor For internal use only.

Parameters:
key - The Flow node key.

FlowNodeInPlan

protected FlowNodeInPlan(Identifier id,
                         FlowNodeInPlanKey key)
Constructor For internal use only.

Parameters:
id - The Flow node Identifier.
key - The Flow node key.
Method Detail

getId

public Identifier getId()
Returns the object identifier.

Specified by:
getId in interface TWSObject
Returns:
The object identifier.

getObjectKey

public TWSKey getObjectKey()
Returns the object key.

Specified by:
getObjectKey in interface TWSObject
Returns:
The object key.
See Also:
TWSHeader.getObjectKey()

getDescription

public java.lang.String getDescription()
Returns the Flow Node description. z/OS only method.

Returns:
the Flow Node description

getFileDependencies

public java.util.List getFileDependencies()
Returns the List of FileDependencyInPlan. If no dependencies are present, an empty List is returned.

Returns:
the List of FileDependencyInPlan

isMonitored

public boolean isMonitored()
Returns if this Flow Node is monitored or not.

Returns:
true if this Flow Node is monitored, false otherwise.

getPromptDependencies

public java.util.List getPromptDependencies()
Returns the List of PromptDependencyInPlan. If no dependencies are present, an empty List is returned.

Returns:
the List of PromptDependencyInPlan

getInterNetworkDependencies

public java.util.List getInterNetworkDependencies()
Returns the List of InternetworkDependencyInPlan. If no dependencies are present, an empty List is returned.

Returns:
the List of InternetworkDependencyInPlan

getResourceDependencies

public java.util.List getResourceDependencies()
Returns the List of ResourceDependencyInPlan. If no dependencies are present, an empty List is returned.

Returns:
the List of ResourceDependencyInPlan

setDescription

public void setDescription(java.lang.String string)
Sets the Description of this Flow node. z/OS only method.

Parameters:
string - the Description of this Flow node

setMonitored

public void setMonitored(boolean b)
Sets if this Flow Node is monitored or not.

Parameters:
b - true if this Flow Node should be monitored, false otherwise.

getExternalDependencies

public java.util.List getExternalDependencies()
Returns the List of ExternalDependencyInPlan. If no dependencies are present, an empty List is returned.

Returns:
the List of ExternalDependencyInPlan

equals

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

Returns:
The object's hash code.

toString

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

Returns:
A text string including all FlowNodeInPlan fields.

getName

public java.lang.String getName()
Returns the Flow Node name.

Specified by:
getName in interface TWSObject
Returns:
The Flow Node name.

getPriority

public int getPriority()
Returns the Flow Node priority.

Returns:
The Flow Node priority.

getOrigPriority

public int getOrigPriority()
Returns the Flow Node original priority.

Returns:
The Flow Node original priority.

getKey

public FlowNodeInPlanKey getKey()
Returns the FlowNodeInPlanKey wrapped by this FlowNodeInPlan object.

Returns:
The FlowNodeInPlanKey wrapped by this FlowNodeInPlan object.

setId

public void setId(Identifier identifier)
Sets the Flow Node Identifier.

Parameters:
identifier - The Flow Node Identifier.

setKey

public void setKey(FlowNodeInPlanKey flowNodeKey)
Sets the FlowNodeInPlanKey to be wrapped by this FlowNodeInPlan object.

Parameters:
flowNodeKey - The FlowNodeInPlanKey to be wrapped by this FlowNodeInPlan object.

setName

public void setName(java.lang.String value)
Sets the Flow Node name.

Parameters:
value - Flow Node name.

setPriority

public void setPriority(int value)
Sets the Flow Node priority.

Parameters:
value - The Flow Node priority.

setOrigPriority

public void setOrigPriority(int value)
Sets the Flow Node original priority. For internal use only.

Parameters:
value - The Flow Node original priority.

getInternalStatus

public FlowNodeInternalStatusType getInternalStatus()
Returns the Flow Node Internal Status. Valid Values are members of FlowNodeInternalStatusType

Returns:
the Flow Node Internal Status

setInternalStatus

public void setInternalStatus(FlowNodeInternalStatusType internalStatus)
Sets the Flow Node Internal Status. For internal use only.

Parameters:
internalStatus - The Flow Node Internal Status.

getElapsedTime

public long getElapsedTime()
Returns The Flow Node Real Duration.

Returns:
The Flow Node Real Duration.

getEstimatedDuration

public long getEstimatedDuration()
Returns The Flow Node Estimated Duration.

Returns:
The Flow Node Estimated Duration.

getTimeRestrictions

public TimeRestrictions getTimeRestrictions()
Returns the Flow Node TimeRestrictions

Returns:
the Flow Node TimeRestrictions

getTimeStarted

public java.util.Date getTimeStarted()
Returns the Date this Flow Node really Started.

Returns:
the Date this Flow Node really Started.

getCpuTime

public long getCpuTime()
Returns the CPU time

Returns:
Returns the CPU time

setElapsedTime

public void setElapsedTime(long l)
Sets the Real Flow Node Duration. For internal use only.

Parameters:
l - the Real Flow Node Duration.

setEstimatedDuration

public void setEstimatedDuration(long l)
Sets the Estimated Flow Node Duration For internal use only.

Parameters:
l - the Estimated Flow Node Duration

setTimeRestrictions

public void setTimeRestrictions(TimeRestrictions restrictions)
Sets the Flow Node Time Restriction. For Internal Use Only. The correct way to change the Time Restriction is to get the previously set ones and change the values set into them.

Parameters:
restrictions - the new Time Restrictions.

setTimeStarted

public void setTimeStarted(java.util.Date l)
Sets the Real Start Time For internal use only.

Parameters:
l - the Real Start Time

setCpuTime

public void setCpuTime(long l)
Sets the CPU time For internal use only.

Parameters:
l - the CPU time

getNumDependencies

public int getNumDependencies()
Returns the Number of Dependencies

Returns:
the Number of Dependencies

setNumDependencies

public void setNumDependencies(int i)
Sets the number of dependencies

Parameters:
i - the number of dependencies

getStatus

public FlowNodeStatusType getStatus()
Returns the status of the Flow Node. Valid values are members of FlowNodeStatusType.

Returns:
the status of the Flow Node.

setStatus

public void setStatus(FlowNodeStatusType type)
Sets the status of the Flow Node For internal use only.

Parameters:
type - the status of the Flow Node

getTimeZone

public java.lang.String getTimeZone()
Returns the Flow Node Timezone

Returns:
the Flow Node Timezone

setTimeZone

public void setTimeZone(java.lang.String string)
Sets the Flow Node Timezone For internal use only.

Parameters:
string - the Flow Node Timezone

getRecordNumber

public long getRecordNumber()
Returns the Flow Node Record Number in the Symphony File For Internal Use Only

Returns:
the Flow Node Record Number

setRecordNumber

public void setRecordNumber(long l)
Sets the Flow Node Record Number in the Symphony File For Internal Use Only

Parameters:
l - the Flow Node Record Number.

getNumberOfFileDependencies

public int getNumberOfFileDependencies()
Returns The Number of File Dependencies

Returns:
The Number of File Dependencies

getNumberOfInternetworkDependencies

public int getNumberOfInternetworkDependencies()
Returns The Number of Internetwork Dependencies

Returns:
The Number of Internetwork Dependencies

getNumberOfJobDependencies

public int getNumberOfJobDependencies()
Returns The Number of Job Dependencies

Returns:
The Number of Job Dependencies

getNumberOfJobStreamDependencies

public int getNumberOfJobStreamDependencies()
Returns The Number of Job Stream Dependencies

Returns:
The Number of Job Stream Dependencies

getNumberOfPromptDependencies

public int getNumberOfPromptDependencies()
Returns The Number of Prompt Dependencies

Returns:
The Number of Prompt Dependencies

getNumberOfResourceDependencies

public int getNumberOfResourceDependencies()
Returns The Number of Resource Dependencies

Returns:
The Number of Resource Dependencies

setNumberOfFileDependencies

public void setNumberOfFileDependencies(int i)
Sets The Number of File Dependencies. For Internal use only.

Parameters:
i - The Number of File Dependencies to set.

setNumberOfInternetworkDependencies

public void setNumberOfInternetworkDependencies(int i)
Sets The Number of Internetwork Dependencies. For internal use only.

Parameters:
i - The Number of Internetwork Dependencies to set.

setNumberOfJobDependencies

public void setNumberOfJobDependencies(int i)
Sets The Number of Job Dependencies. For internal use only.

Parameters:
i - The Number of Job Dependencies to set.

setNumberOfJobStreamDependencies

public void setNumberOfJobStreamDependencies(int i)
Sets The Number of Job Stream Dependencies. For internal use only.

Parameters:
i - The Number of Job Stream Dependencies to set.

setNumberOfPromptDependencies

public void setNumberOfPromptDependencies(int i)
Sets The Number of Prompt Dependencies. For internal use only.

Parameters:
i - The Number of Prompt Dependencies to set.

setNumberOfResourceDependencies

public void setNumberOfResourceDependencies(int i)
Sets The Number of Resource Dependencies. For internal use only.

Parameters:
i - The Number of Resource Dependencies to set.


Copyright © 2005 IBM All Rights Reserved.