|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.tws.objects.plan.FlowNodeInPlan
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> |
TimeRestrictions
,
FlowNodeInternalStatusType
,
FlowNodeStatusType
,
JobStreamInPlan
,
JobInPlan
,
ResourceDependencyInPlan
,
FileDependencyInPlan
,
PromptDependencyInPlan
,
ExternalDependencyInPlan
,
InternetworkDependencyInPlan
,
Serialized FormField 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 |
public static final java.lang.String COPYRIGHT
Constructor Detail |
protected FlowNodeInPlan()
protected FlowNodeInPlan(Identifier id)
id
- The Flow node Identifier.protected FlowNodeInPlan(FlowNodeInPlanKey key)
key
- The Flow node key.protected FlowNodeInPlan(Identifier id, FlowNodeInPlanKey key)
id
- The Flow node Identifier.key
- The Flow node key.Method Detail |
public Identifier getId()
getId
in interface TWSObject
public TWSKey getObjectKey()
getObjectKey
in interface TWSObject
TWSHeader.getObjectKey()
public java.lang.String getDescription()
public java.util.List getFileDependencies()
public boolean isMonitored()
public java.util.List getPromptDependencies()
public java.util.List getInterNetworkDependencies()
public java.util.List getResourceDependencies()
public void setDescription(java.lang.String string)
string
- the Description of this Flow nodepublic void setMonitored(boolean b)
b
- true if this Flow Node should be monitored, false otherwise.public java.util.List getExternalDependencies()
public boolean equals(java.lang.Object object)
object
- The object to be compared with this one.
public int hashCode()
public java.lang.String toString()
public java.lang.String getName()
getName
in interface TWSObject
public int getPriority()
public int getOrigPriority()
public FlowNodeInPlanKey getKey()
public void setId(Identifier identifier)
identifier
- The Flow Node Identifier.public void setKey(FlowNodeInPlanKey flowNodeKey)
flowNodeKey
- The FlowNodeInPlanKey to be wrapped by this FlowNodeInPlan object.public void setName(java.lang.String value)
value
- Flow Node name.public void setPriority(int value)
value
- The Flow Node priority.public void setOrigPriority(int value)
value
- The Flow Node original priority.public FlowNodeInternalStatusType getInternalStatus()
public void setInternalStatus(FlowNodeInternalStatusType internalStatus)
internalStatus
- The Flow Node Internal Status.public long getElapsedTime()
public long getEstimatedDuration()
public TimeRestrictions getTimeRestrictions()
public java.util.Date getTimeStarted()
public long getCpuTime()
public void setElapsedTime(long l)
l
- the Real Flow Node Duration.public void setEstimatedDuration(long l)
l
- the Estimated Flow Node Durationpublic void setTimeRestrictions(TimeRestrictions restrictions)
restrictions
- the new Time Restrictions.public void setTimeStarted(java.util.Date l)
l
- the Real Start Timepublic void setCpuTime(long l)
l
- the CPU timepublic int getNumDependencies()
public void setNumDependencies(int i)
i
- the number of dependenciespublic FlowNodeStatusType getStatus()
public void setStatus(FlowNodeStatusType type)
type
- the status of the Flow Nodepublic java.lang.String getTimeZone()
public void setTimeZone(java.lang.String string)
string
- the Flow Node Timezonepublic long getRecordNumber()
public void setRecordNumber(long l)
l
- the Flow Node Record Number.public int getNumberOfFileDependencies()
public int getNumberOfInternetworkDependencies()
public int getNumberOfJobDependencies()
public int getNumberOfJobStreamDependencies()
public int getNumberOfPromptDependencies()
public int getNumberOfResourceDependencies()
public void setNumberOfFileDependencies(int i)
i
- The Number of File Dependencies to set.public void setNumberOfInternetworkDependencies(int i)
i
- The Number of Internetwork Dependencies to set.public void setNumberOfJobDependencies(int i)
i
- The Number of Job Dependencies to set.public void setNumberOfJobStreamDependencies(int i)
i
- The Number of Job Stream Dependencies to set.public void setNumberOfPromptDependencies(int i)
i
- The Number of Prompt Dependencies to set.public void setNumberOfResourceDependencies(int i)
i
- The Number of Resource Dependencies to set.
|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |