com.ibm.tws.objects.model
Class FlowNode

java.lang.Object
  extended bycom.ibm.tws.objects.model.FlowNode
All Implemented Interfaces:
java.io.Serializable, TWSObject
Direct Known Subclasses:
Job, JobStream

public abstract class FlowNode
extends java.lang.Object
implements TWSObject

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:

  • If multiple external dependencies have the same predecessor and resolution data, only the last one is saved
  • If multiple inter-network dependencies have the same network agent and dependency string, only the last one is saved
  • If multiple prompt dependencies have the same predefined or ad hoc prompt, only the last one is saved
  • If multiple file dependencies have the same file name, qualifiers and workstation, only the last one is saved
  • If multiple resource dependencies have the same resource, only the last one is saved with the total quantity
  • See Also:
    TimeRestrictions, ExternalDependency, InterNetworkDependency, PromptDependency, FileDependency, ResourceDependency, Serialized Form

    Field 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

    COPYRIGHT

    public static final java.lang.String COPYRIGHT
    Copyright.


    DEFAULT_PRIORITY

    public static final int DEFAULT_PRIORITY
    The default priority for jobs and job streams.

    See Also:
    Constant Field Values
    Constructor Detail

    FlowNode

    protected FlowNode(FlowNodeHeader flowNodeHeader)
    Creates a FlowNode with the specified header.

    Parameters:
    flowNodeHeader - The job stream or job header.
    Method Detail

    getId

    public Identifier getId()
    Returns the job stream or job identifier.

    Specified by:
    getId in interface TWSObject
    Returns:
    The job stream or job identifier.

    getObjectKey

    public TWSKey getObjectKey()
    Returns the job stream or job key as a TWS key.

    Specified by:
    getObjectKey in interface TWSObject
    Returns:
    The job stream or job key as a TWS key.

    getObjectHeader

    public TWSHeader getObjectHeader()
    Returns the job stream or job header as a TWS header.

    Specified by:
    getObjectHeader in interface TWSObject
    Returns:
    The job stream or job header as a TWS header.

    getKey

    public FlowNodeKey getKey()
    Returns the FlowNodeKey wrapped by this FlowNode object.

    Returns:
    The FlowNodeKey wrapped by this FlowNode object.

    getHeader

    public FlowNodeHeader getHeader()
    Returns the FlowNodeHeader wrapped by this FlowNode object.

    Returns:
    The FlowNodeHeader wrapped by this FlowNode object.

    getName

    public java.lang.String getName()
    Returns the job stream or job name.

    Specified by:
    getName in interface TWSObject
    Returns:
    The job stream or job name.

    getDescription

    public java.lang.String getDescription()
    Returns the job stream or job description.

    Returns:
    The job stream or job description.

    getPriority

    public int getPriority()
    Returns the job stream or job priority.

    Returns:
    The job stream or job priority.

    getTimeZone

    public java.lang.String getTimeZone()
    Returns the job stream or job timezone.

    Returns:
    The job stream or job timezone.

    getAbstractId

    public Identifier getAbstractId()
    Returns the abstract job stream or abstract job identifier.

    Returns:
    The abstract job stream or abstract job identifier.

    isMonitored

    public boolean isMonitored()
    Returns true if the job stream or job is monitored. Not supported on zOS (returns false).

    Returns:
    True if the job stream or job is monitored.

    getTimeRestrictions

    public TimeRestrictions getTimeRestrictions()
    Returns the job stream or job time restrictions.

    Returns:
    The job stream or job time restrictions.

    getComment

    public java.lang.String getComment()
    Returns the job stream or job comment text.

    Returns:
    The job stream or job comment text.

    getExternalDependencies

    public java.util.List getExternalDependencies()
    Returns a reference to the list of external dependencies for this job stream or job.

    Returns:
    A reference to the list of external dependencies for this job stream or job.

    getInterNetworkDependencies

    public java.util.List getInterNetworkDependencies()
    Returns a reference to the list of inter-network dependencies for this job stream or job.

    Returns:
    A reference to the list of inter-network dependencies for this job stream or job.

    getFileDependencies

    public java.util.List getFileDependencies()
    Returns a reference to the list of file dependencies for this job stream or job.

    Returns:
    A reference to the list of file dependencies for this job stream or job.

    getPromptDependencies

    public java.util.List getPromptDependencies()
    Returns a reference to the list of prompt dependencies for this job stream or job.

    Returns:
    A reference to the list of prompt dependencies for this job stream or job.

    getResourceDependencies

    public java.util.List getResourceDependencies()
    Returns a reference to the list of resource dependencies for this job stream or job.

    Returns:
    A reference to the list of resource dependencies for this job stream or job.

    setId

    public void setId(Identifier identifier)
    Sets the job stream or job identifier.

    Parameters:
    identifier - The job stream or job identifier.

    setKey

    public void setKey(FlowNodeKey flowNodeKey)
    Sets the FlowNodeKey to be wrapped by this FlowNode object.

    Parameters:
    flowNodeKey - The FlowNodeKey to be wrapped by this FlowNode object.

    setHeader

    public void setHeader(FlowNodeHeader flowNodeHeader)
    Sets the FlowNodeHeader to be wrapped by this FlowNode object.

    Parameters:
    flowNodeHeader - The FlowNodeHeader to be wrapped by this FlowNode object.

    setName

    public void setName(java.lang.String value)
    Sets the job stream or job name.

    Parameters:
    value - The job stream or job name.

    setDescription

    public void setDescription(java.lang.String value)
    Sets the job stream or job description.

    Parameters:
    value - The job stream or job description.

    setPriority

    public void setPriority(int value)
    Sets the job stream or job priority.

    Parameters:
    value - The job stream or job priority.

    setTimeZone

    public void setTimeZone(java.lang.String value)
    Sets the job stream or job timezone.

    Parameters:
    value - The job stream or job timezone.

    setAbstractId

    public void setAbstractId(Identifier identifier)
    Sets the abstract job stream or abstract job identifier.

    Parameters:
    identifier - The abstract job stream or abstract job identifier.

    setMonitored

    public void setMonitored(boolean value)
    Sets the property used to decide if this job stream or job is monitored. Not supported on zOS.

    Parameters:
    value - True if this job stream or job is monitored.

    setTimeRestrictions

    public void setTimeRestrictions(TimeRestrictions restrictions)
    Sets the job stream or job time restrictions.

    Parameters:
    restrictions - The job stream or job time restrictions.

    setComment

    public void setComment(java.lang.String text)
    Sets the job stream or job comment text.

    Parameters:
    text - The job stream or job comment text.

    equals

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

    Returns:
    The object's hash code.

    toString

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

    Returns:
    A text string including all FlowNode fields.


    Copyright © 2005 IBM All Rights Reserved.