|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.tws.objects.model.FlowNode
This is a base class for Job and JobStream and is mainly used to maintain the dependency lists that are common to jobs and job streams: therefore a FlowNode references multiple FileDependency, ResourceDependency, PromptDependency, ExternalDependency and InterNetworkDependency objects. A FlowNode also wraps a FlowNodeHeader, which in turn wraps a FlowNodeKey.
The following syntax validation constraints must be met on FlowNode objects:
name | Always required |
Alphanumeric characters | |
Starting with alphabetic character | |
'-' and '_' characters allowed | |
Blank spaces not allowed | |
description | Not longer than 120 characters |
priority | Allowed range is from 0 to 101 |
Default value is 10 | |
timeZone | If specified, must be allowed by TZ library and Java |
Not longer than 40 characters | |
timeRestrictions | See TimeRestrictions for constraints on this field |
comment | Multiline free-form text field |
Each line must not be longer than 1000 characters | |
externalDependencies | A list of ExternalDependency objects |
See ExternalDependency for other constraints | |
interNetworkDependencies | A list of InterNetworkDependency objects |
See InterNetworkDependency for other constraints | |
promptDependencies | A list of PromptDependency objects |
See PromptDependency for other constraints | |
fileDependencies | A list of FileDependency objects |
See FileDependency for other constraints | |
resourceDependencies | A list of ResourceDependency objects |
See ResourceDependency for other constraints |
About lists of dependencies, notice that if you add twice the same dependency to a list, only the last instance added to the list is stored when creating or modifying the object. More specifically:
TimeRestrictions
,
ExternalDependency
,
InterNetworkDependency
,
PromptDependency
,
FileDependency
,
ResourceDependency
,
Serialized FormField Summary | |
---|---|
static java.lang.String |
COPYRIGHT
Copyright. |
static int |
DEFAULT_PRIORITY
The default priority for jobs and job streams. |
Constructor Summary | |
---|---|
protected |
FlowNode(FlowNodeHeader flowNodeHeader)
Creates a FlowNode with the specified header. |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object object)
Returns true if all fields of this FlowNode object are equal to those of the given one. |
Identifier |
getAbstractId()
Returns the abstract job stream or abstract job identifier. |
java.lang.String |
getComment()
Returns the job stream or job comment text. |
java.lang.String |
getDescription()
Returns the job stream or job description. |
java.util.List |
getExternalDependencies()
Returns a reference to the list of external dependencies for this job stream or job. |
java.util.List |
getFileDependencies()
Returns a reference to the list of file dependencies for this job stream or job. |
FlowNodeHeader |
getHeader()
Returns the FlowNodeHeader wrapped by this FlowNode object. |
Identifier |
getId()
Returns the job stream or job identifier. |
java.util.List |
getInterNetworkDependencies()
Returns a reference to the list of inter-network dependencies for this job stream or job. |
FlowNodeKey |
getKey()
Returns the FlowNodeKey wrapped by this FlowNode object. |
java.lang.String |
getName()
Returns the job stream or job name. |
TWSHeader |
getObjectHeader()
Returns the job stream or job header as a TWS header. |
TWSKey |
getObjectKey()
Returns the job stream or job key as a TWS key. |
int |
getPriority()
Returns the job stream or job priority. |
java.util.List |
getPromptDependencies()
Returns a reference to the list of prompt dependencies for this job stream or job. |
java.util.List |
getResourceDependencies()
Returns a reference to the list of resource dependencies for this job stream or job. |
TimeRestrictions |
getTimeRestrictions()
Returns the job stream or job time restrictions. |
java.lang.String |
getTimeZone()
Returns the job stream or job timezone. |
int |
hashCode()
Returns a hash code for this FlowNode object. |
boolean |
isMonitored()
Returns true if the job stream or job is monitored. |
void |
setAbstractId(Identifier identifier)
Sets the abstract job stream or abstract job identifier. |
void |
setComment(java.lang.String text)
Sets the job stream or job comment text. |
void |
setDescription(java.lang.String value)
Sets the job stream or job description. |
void |
setHeader(FlowNodeHeader flowNodeHeader)
Sets the FlowNodeHeader to be wrapped by this FlowNode object. |
void |
setId(Identifier identifier)
Sets the job stream or job identifier. |
void |
setKey(FlowNodeKey flowNodeKey)
Sets the FlowNodeKey to be wrapped by this FlowNode object. |
void |
setMonitored(boolean value)
Sets the property used to decide if this job stream or job is monitored. |
void |
setName(java.lang.String value)
Sets the job stream or job name. |
void |
setPriority(int value)
Sets the job stream or job priority. |
void |
setTimeRestrictions(TimeRestrictions restrictions)
Sets the job stream or job time restrictions. |
void |
setTimeZone(java.lang.String value)
Sets the job stream or job timezone. |
java.lang.String |
toString()
Returns a string representation of this FlowNode object. |
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 |
Field Detail |
public static final java.lang.String COPYRIGHT
public static final int DEFAULT_PRIORITY
Constructor Detail |
protected FlowNode(FlowNodeHeader flowNodeHeader)
flowNodeHeader
- The job stream or job header.Method Detail |
public Identifier getId()
getId
in interface TWSObject
public TWSKey getObjectKey()
getObjectKey
in interface TWSObject
public TWSHeader getObjectHeader()
getObjectHeader
in interface TWSObject
public FlowNodeKey getKey()
public FlowNodeHeader getHeader()
public java.lang.String getName()
getName
in interface TWSObject
public java.lang.String getDescription()
public int getPriority()
public java.lang.String getTimeZone()
public Identifier getAbstractId()
public boolean isMonitored()
public TimeRestrictions getTimeRestrictions()
public java.lang.String getComment()
public java.util.List getExternalDependencies()
public java.util.List getInterNetworkDependencies()
public java.util.List getFileDependencies()
public java.util.List getPromptDependencies()
public java.util.List getResourceDependencies()
public void setId(Identifier identifier)
identifier
- The job stream or job identifier.public void setKey(FlowNodeKey flowNodeKey)
flowNodeKey
- The FlowNodeKey to be wrapped by this FlowNode object.public void setHeader(FlowNodeHeader flowNodeHeader)
flowNodeHeader
- The FlowNodeHeader to be wrapped by this FlowNode object.public void setName(java.lang.String value)
value
- The job stream or job name.public void setDescription(java.lang.String value)
value
- The job stream or job description.public void setPriority(int value)
value
- The job stream or job priority.public void setTimeZone(java.lang.String value)
value
- The job stream or job timezone.public void setAbstractId(Identifier identifier)
identifier
- The abstract job stream or abstract job identifier.public void setMonitored(boolean value)
value
- True if this job stream or job is monitored.public void setTimeRestrictions(TimeRestrictions restrictions)
restrictions
- The job stream or job time restrictions.public void setComment(java.lang.String text)
text
- The job stream or job comment text.public boolean equals(java.lang.Object object)
object
- The object to be compared with this one.
public int hashCode()
public java.lang.String toString()
|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |