com.ibm.tws.objects.model
Class JobStream

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

public class JobStream
extends FlowNode

This object represents a job stream and includes a list of Job objects to represent the jobs contained in the stream. It is a subclass of FlowNode, through which it wraps JobStreamHeader that in turns wraps JobStreamKey through FlowNodeHeader. A job stream is externally identified by its name, its validFrom date and the referenced workstation or workstation class, as shown by JobStreamKey.

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

name Always required
Alphanumeric characters
Starting with alphabetic character
'-' and '_' characters allowed
Blank spaces not allowed
Not longer than 16 characters
flowTargetKey Must reference an existing workstation or class
validFrom Time must be GMT midnight, but the meaning is "start of day"
Always required
Values stored on the database are truncated to GMT midnight
validTo Default is the validFrom value of the next version
This is a read-only field
nextTimeZone Default is the timeZone value of the next version
This is a read-only field
draft Default value is false
carryForward Default value is false
monitored Default value is false
limit Allowed range is from -1 to 1024
Default value is -1 (reserved as an unlimited value)
onRequest Default value is false
hasMonitoredJob Default value is false
isSaturdayFree Default value is true
isSundayFree Default value is true
resolutionData See ResolutionData for constraints on this field
freeDaysCalendarKey If specified, must reference an existing calendar
jobs A list of Job objects
See Job for other constraints
runCycles A list of RunCycle objects
See RunCycle for other constraints

About lists of jobs and run cycles, notice that if you add twice the same object to a list, only the last instance added to the list is stored when creating or modifying the job stream. More specifically:

  • If multiple jobs have the same identifier, or the same name and no identifier, only the last one is saved
  • If multiple run cycles have the same identifier, or the same name and no identifier, only the last one is saved
  • The following syntax validation constraints must be met on JobStream objects in z/OS environment:

    name Always required
    Alphanumeric characters
    Starting with alphabetic character
    Blank spaces not allowed
    It is converted to upper case
    Not longer than 16 characters
    description Not longer than 24 characters
    flowTargetKey N/A
    validFrom Time must be GMT midnight, but the meaning is "start of day"
    Always required
    Values stored on the database are truncated to GMT midnight
    validTo Default is the validFrom value of the next version
    This is a read-only field
    nextTimeZone N/A
    draft Default value is false
    carryForward N/A
    monitored N/A
    limit N/A
    onRequest N/A
    hasMonitoredJob Monitoring flag: default value is false
    This flag is ignored if the version of Tivoli Workload Scheduler is prior to 8.1
    isSaturdayFree N/A
    isSundayFree N/A
    resolutionData N/A
    freeDaysCalendarKey If specified, must reference an existing calendar
    jobs A list of Job objects
    See Job for other constraints
    runCycles A list of RunCycle objects
    See RunCycle for other constraints

    See Also:
    FlowNode, ResolutionData, Job, RunCycle, ExternalDependency, InterNetworkDependency, PromptDependency, FileDependency, ResourceDependency, Serialized Form

    Field Summary
    static java.lang.String COPYRIGHT
              Copyright.
    static int NO_LIMIT
              The constant used to check for unbounded job stream limit.
     
    Fields inherited from class com.ibm.tws.objects.model.FlowNode
    DEFAULT_PRIORITY
     
    Constructor Summary
    JobStream()
              Creates an empty JobStream.
    JobStream(JobStreamHeader jobStreamHeader)
              Creates a job stream with the specified header.
     
    Method Summary
     boolean equals(java.lang.Object object)
              Returns true if all fields of this JobStream object are equal to those of the given one.
     java.lang.String getAuthorityGroup()
              Returns the job stream authority group.
     boolean getCarryForward()
              Returns the job stream carryForward property.
     int getDeadlineLimitFeedback()
              Returns the job stream deadline limit feedback.
     int getDeadlineSmoothingFactor()
              Returns the job stream deadline smoothing factor.
     Identifier getFlowTargetId()
              Returns the identifier of the workstation or workstation class referenced by this job stream.
     FlowTargetKey getFlowTargetKey()
              Returns the key of the workstation or workstation class referenced by this job stream.
     Identifier getFreeDaysCalendarId()
              Returns the identifier of the free days calendar used with this job stream.
     CalendarKey getFreeDaysCalendarKey()
              Returns the key of the free days calendar used with this job stream.
     java.lang.String getGroupName()
              Returns the job stream group name.
     java.util.List getJobs()
              Returns a reference to the list of jobs included in this job stream.
     int getLimit()
              Returns the job stream limit.
     LockData getLockData()
              Returns the job stream lock data.
     ModifyData getModifyData()
              Returns the job stream modification data.
     java.lang.String getNextTimeZone()
              Returns the time zone of the following job stream version.
     java.lang.String getOwnerDescription()
              Returns the job stream owner description.
     java.lang.String getOwnerName()
              Returns the job stream owner name.
     ResolutionData getResolutionData()
              Returns the default criteria to be used for resolving external dependencies.
     java.util.List getRunCycles()
              Returns a reference to the list of run cycles defined for this job stream.
     java.util.Date getValidFrom()
              Returns the start date of the job stream validity period.
     java.util.Date getValidTo()
              Returns the end date of the job stream validity period.
     int hashCode()
              Returns a hash code for this JobStream object.
     boolean hasMonitoredJob()
              Returns true if this job stream contains a monitored job.
     boolean isDraft()
              Returns true if this job stream is a draft one.
     boolean isGroup()
              Returns true if this job stream is a group of job streams.
     boolean isOnRequest()
              Returns true if this job stream runs on request.
     boolean isSaturdayFree()
              Returns true if saturday is considered as a free day for this job stream.
     boolean isSundayFree()
              Returns true if sunday is considered as a free day for this job stream.
     void replaceLists(JobStream jobStream)
              Replaces the current lists of jobs, run cycles and all dependencies with those of the specified job stream.
     void setAuthorityGroupName(java.lang.String value)
              Sets the job stream authority group.
     void setCarryForward(boolean value)
              Sets the job stream carryForward property.
     void setDeadlineLimitFeedback(int value)
              Sets the deadline limit feedback used with this job stream.
     void setDeadlineSmoothingFactor(int value)
              Sets the deadline smoothing factor used with this job stream.
     void setDraft(boolean value)
              Sets the property used to decide if this job stream is a draft one.
     void setFlowTargetId(Identifier identifier)
              Set the identifier of the workstation or workstation class referenced by this job stream.
     void setFlowTargetKey(FlowTargetKey key)
              Sets the key of the workstation or workstation class referenced by this job stream.
     void setFreeDaysCalendarId(Identifier identifier)
              Sets the identifier of the free days calendar used with this job stream.
     void setFreeDaysCalendarKey(CalendarKey key)
              Sets the key of the free days calendar used with this job stream.
     void setGroup(boolean value)
              Sets the property used to decide if this job stream is a group of job streams.
     void setGroupName(java.lang.String value)
              Sets the job stream group name.
     void setHasMonitoredJob(boolean value)
              Sets the property used to decide if this job stream contains a monitored job.
     void setLimit(int value)
              Sets the job stream limit.
     void setLockData(LockData data)
              Sets the job stream lock data.
     void setModifyData(ModifyData data)
              Sets the job stream modification data.
     void setNextTimeZone(java.lang.String value)
              Sets the time zone of the following job stream version.
     void setOnRequest(boolean value)
              Sets the property used to decide if this job stream runs on request.
     void setOwnerDescription(java.lang.String value)
              Sets the job stream owner description.
     void setOwnerName(java.lang.String value)
              Sets the job stream owner name.
     void setResolutionData(ResolutionData data)
              Sets the default criteria to be used for resolving external dependencies.
     void setSaturdayFree(boolean value)
              Sets the property used to decide if saturday is considered as a free day for this job stream.
     void setSundayFree(boolean value)
              Sets the property used to decide if sunday is considered as a free day for this job stream.
     void setValidFrom(java.util.Date value)
              Sets the start date of the job stream validity period.
     void setValidTo(java.util.Date value)
              Sets the end date of the job stream validity period.
     java.lang.String toString()
              Returns a string representation of this JobStream object.
     
    Methods inherited from class com.ibm.tws.objects.model.FlowNode
    getAbstractId, getComment, getDescription, getExternalDependencies, getFileDependencies, getHeader, getId, getInterNetworkDependencies, getKey, getName, getObjectHeader, getObjectKey, getPriority, getPromptDependencies, getResourceDependencies, getTimeRestrictions, getTimeZone, isMonitored, setAbstractId, setComment, setDescription, setHeader, setId, setKey, setMonitored, setName, setPriority, setTimeRestrictions, setTimeZone
     
    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.


    NO_LIMIT

    public static final int NO_LIMIT
    The constant used to check for unbounded job stream limit.

    See Also:
    Constant Field Values
    Constructor Detail

    JobStream

    public JobStream()
    Creates an empty JobStream.


    JobStream

    public JobStream(JobStreamHeader jobStreamHeader)
    Creates a job stream with the specified header.

    Parameters:
    jobStreamHeader - The job stream header.
    Method Detail

    getFlowTargetKey

    public FlowTargetKey getFlowTargetKey()
    Returns the key of the workstation or workstation class referenced by this job stream.

    Returns:
    The key of the workstation or workstation class referenced by this job stream.

    getValidFrom

    public java.util.Date getValidFrom()
    Returns the start date of the job stream validity period.

    Returns:
    The start date of the job stream validity period.

    getValidTo

    public java.util.Date getValidTo()
    Returns the end date of the job stream validity period.

    Returns:
    The end date of the job stream validity period.

    getNextTimeZone

    public java.lang.String getNextTimeZone()
    Returns the time zone of the following job stream version.

    Returns:
    The time zone of the following job stream version.

    isDraft

    public boolean isDraft()
    Returns true if this job stream is a draft one.

    Returns:
    True if this job stream is a draft one.

    getCarryForward

    public boolean getCarryForward()
    Returns the job stream carryForward property.

    Returns:
    The job stream carryForward property.

    getLimit

    public int getLimit()
    Returns the job stream limit.

    Returns:
    The job stream limit.

    isGroup

    public boolean isGroup()
    Returns true if this job stream is a group of job streams.

    Returns:
    True if this job stream is a group of job streams.

    getGroupName

    public java.lang.String getGroupName()
    Returns the job stream group name.

    Returns:
    The job stream group name.

    getOwnerName

    public java.lang.String getOwnerName()
    Returns the job stream owner name.

    Returns:
    The job stream owner name.

    getOwnerDescription

    public java.lang.String getOwnerDescription()
    Returns the job stream owner description.

    Returns:
    The job stream owner description.

    getAuthorityGroup

    public java.lang.String getAuthorityGroup()
    Returns the job stream authority group.

    Returns:
    The job stream authority group.

    getFreeDaysCalendarKey

    public CalendarKey getFreeDaysCalendarKey()
    Returns the key of the free days calendar used with this job stream.

    Returns:
    The key of the free days calendar used with this job stream.

    getDeadlineSmoothingFactor

    public int getDeadlineSmoothingFactor()
    Returns the job stream deadline smoothing factor.

    Returns:
    The job stream deadline smoothing factor.

    getDeadlineLimitFeedback

    public int getDeadlineLimitFeedback()
    Returns the job stream deadline limit feedback.

    Returns:
    The job stream deadline limit feedback.

    getModifyData

    public ModifyData getModifyData()
    Returns the job stream modification data.

    Returns:
    The job stream modification data.

    getLockData

    public LockData getLockData()
    Returns the job stream lock data.

    Returns:
    The job stream lock data.

    getFlowTargetId

    public Identifier getFlowTargetId()
    Returns the identifier of the workstation or workstation class referenced by this job stream.

    Returns:
    The identifier of the workstation or workstation class referenced by this job stream.

    isOnRequest

    public boolean isOnRequest()
    Returns true if this job stream runs on request.

    Returns:
    True if this job stream runs on request.

    hasMonitoredJob

    public boolean hasMonitoredJob()
    Returns true if this job stream contains a monitored job. Not supported on zOS if version is not 8.1 (returns false).

    Returns:
    True if this job stream contains a monitored job.

    isSaturdayFree

    public boolean isSaturdayFree()
    Returns true if saturday is considered as a free day for this job stream.

    Returns:
    True if saturday is considered as a free day for this job stream.

    isSundayFree

    public boolean isSundayFree()
    Returns true if sunday is considered as a free day for this job stream.

    Returns:
    True if sunday is considered as a free day for this job stream.

    getResolutionData

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

    Returns:
    The default criteria to be used for resolving external dependencies.

    getFreeDaysCalendarId

    public Identifier getFreeDaysCalendarId()
    Returns the identifier of the free days calendar used with this job stream.

    Returns:
    The identifier of the free days calendar used with this job stream.

    getJobs

    public java.util.List getJobs()
    Returns a reference to the list of jobs included in this job stream.

    Returns:
    A reference to the list of jobs included in this job stream.

    getRunCycles

    public java.util.List getRunCycles()
    Returns a reference to the list of run cycles defined for this job stream.

    Returns:
    A reference to the list of run cycles defined for this job stream.

    setFlowTargetKey

    public void setFlowTargetKey(FlowTargetKey key)
    Sets the key of the workstation or workstation class referenced by this job stream.

    Parameters:
    key - The key of the workstation or workstation class referenced by this job stream.

    setValidFrom

    public void setValidFrom(java.util.Date value)
    Sets the start date of the job stream validity period. Values stored on the database are truncated to GMT midnight.

    Parameters:
    value - The start date of the job stream validity period.

    setValidTo

    public void setValidTo(java.util.Date value)
    Sets the end date of the job stream validity period. For internal use only.

    Parameters:
    value - The end date of the job stream validity period.

    setNextTimeZone

    public void setNextTimeZone(java.lang.String value)
    Sets the time zone of the following job stream version. For internal use only.

    Parameters:
    value - The time zone of the following job stream version.

    setDraft

    public void setDraft(boolean value)
    Sets the property used to decide if this job stream is a draft one.

    Parameters:
    value - True if this job stream is a draft one.

    setCarryForward

    public void setCarryForward(boolean value)
    Sets the job stream carryForward property.

    Parameters:
    value - The job stream carryForward property.

    setLimit

    public void setLimit(int value)
    Sets the job stream limit.

    Parameters:
    value - The job stream limit.

    setGroup

    public void setGroup(boolean value)
    Sets the property used to decide if this job stream is a group of job streams.

    Parameters:
    value - True if this job stream is a group of job streams.

    setGroupName

    public void setGroupName(java.lang.String value)
    Sets the job stream group name.

    Parameters:
    value - The job stream group name.

    setOwnerName

    public void setOwnerName(java.lang.String value)
    Sets the job stream owner name.

    Parameters:
    value - The job stream owner name.

    setOwnerDescription

    public void setOwnerDescription(java.lang.String value)
    Sets the job stream owner description.

    Parameters:
    value - The job stream owner description.

    setAuthorityGroupName

    public void setAuthorityGroupName(java.lang.String value)
    Sets the job stream authority group.

    Parameters:
    value - The job stream authority group.

    setFreeDaysCalendarKey

    public void setFreeDaysCalendarKey(CalendarKey key)
    Sets the key of the free days calendar used with this job stream.

    Parameters:
    key - The key of the free days calendar used with this job stream.

    setDeadlineSmoothingFactor

    public void setDeadlineSmoothingFactor(int value)
    Sets the deadline smoothing factor used with this job stream.

    Parameters:
    value - The deadline smoothing factor used with this job stream.

    setDeadlineLimitFeedback

    public void setDeadlineLimitFeedback(int value)
    Sets the deadline limit feedback used with this job stream.

    Parameters:
    value - The deadline limit feedback used with this job stream.

    setModifyData

    public void setModifyData(ModifyData data)
    Sets the job stream modification data. For internal use only.

    Parameters:
    data - A ModifyData object.

    setLockData

    public void setLockData(LockData data)
    Sets the job stream lock data. For internal use only.

    Parameters:
    data - A LockData object.

    setFlowTargetId

    public void setFlowTargetId(Identifier identifier)
    Set the identifier of the workstation or workstation class referenced by this job stream.

    Parameters:
    identifier - The identifier of the workstation or workstation class referenced by this job stream.

    setOnRequest

    public void setOnRequest(boolean value)
    Sets the property used to decide if this job stream runs on request.

    Parameters:
    value - True if this job stream runs on request.

    setHasMonitoredJob

    public void setHasMonitoredJob(boolean value)
    Sets the property used to decide if this job stream contains a monitored job. On zOS, this is for internal use only.

    Parameters:
    value - True if this job stream contains a monitored job.

    setSaturdayFree

    public void setSaturdayFree(boolean value)
    Sets the property used to decide if saturday is considered as a free day for this job stream.

    Parameters:
    value - True if saturday is considered as a free day for this job stream.

    setSundayFree

    public void setSundayFree(boolean value)
    Sets the property used to decide if sunday is considered as a free day for this job stream.

    Parameters:
    value - True if sunday is considered as a free day for this job stream.

    setResolutionData

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

    Parameters:
    data - The default criteria to be used for resolving external dependencies.

    setFreeDaysCalendarId

    public void setFreeDaysCalendarId(Identifier identifier)
    Sets the identifier of the free days calendar used with this job stream.

    Parameters:
    identifier - The identifier of the free days calendar used with this job stream.

    replaceLists

    public void replaceLists(JobStream jobStream)
    Replaces the current lists of jobs, run cycles and all dependencies with those of the specified job stream.

    Parameters:
    jobStream - The job stream whose lists of jobs, run cycles and all dependencies must replace the current ones.

    equals

    public boolean equals(java.lang.Object object)
    Returns true if all fields of this JobStream object are equal to those of the given one.

    Overrides:
    equals in class FlowNode
    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 JobStream object.

    Overrides:
    hashCode in class FlowNode
    Returns:
    The object's hash code.

    toString

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

    Overrides:
    toString in class FlowNode
    Returns:
    A text string including all JobStream fields.


    Copyright © 2005 IBM All Rights Reserved.