|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.tws.objects.model.FlowNode
com.ibm.tws.objects.model.JobStream
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:
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 |
FlowNode
,
ResolutionData
,
Job
,
RunCycle
,
ExternalDependency
,
InterNetworkDependency
,
PromptDependency
,
FileDependency
,
ResourceDependency
,
Serialized FormField 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 |
public static final java.lang.String COPYRIGHT
public static final int NO_LIMIT
Constructor Detail |
public JobStream()
public JobStream(JobStreamHeader jobStreamHeader)
jobStreamHeader
- The job stream header.Method Detail |
public FlowTargetKey getFlowTargetKey()
public java.util.Date getValidFrom()
public java.util.Date getValidTo()
public java.lang.String getNextTimeZone()
public boolean isDraft()
public boolean getCarryForward()
public int getLimit()
public boolean isGroup()
public java.lang.String getGroupName()
public java.lang.String getOwnerName()
public java.lang.String getOwnerDescription()
public java.lang.String getAuthorityGroup()
public CalendarKey getFreeDaysCalendarKey()
public int getDeadlineSmoothingFactor()
public int getDeadlineLimitFeedback()
public ModifyData getModifyData()
public LockData getLockData()
public Identifier getFlowTargetId()
public boolean isOnRequest()
public boolean hasMonitoredJob()
public boolean isSaturdayFree()
public boolean isSundayFree()
public ResolutionData getResolutionData()
public Identifier getFreeDaysCalendarId()
public java.util.List getJobs()
public java.util.List getRunCycles()
public void setFlowTargetKey(FlowTargetKey key)
key
- The key of the workstation or workstation class referenced by this job stream.public void setValidFrom(java.util.Date value)
value
- The start date of the job stream validity period.public void setValidTo(java.util.Date value)
value
- The end date of the job stream validity period.public void setNextTimeZone(java.lang.String value)
value
- The time zone of the following job stream version.public void setDraft(boolean value)
value
- True if this job stream is a draft one.public void setCarryForward(boolean value)
value
- The job stream carryForward property.public void setLimit(int value)
value
- The job stream limit.public void setGroup(boolean value)
value
- True if this job stream is a group of job streams.public void setGroupName(java.lang.String value)
value
- The job stream group name.public void setOwnerName(java.lang.String value)
value
- The job stream owner name.public void setOwnerDescription(java.lang.String value)
value
- The job stream owner description.public void setAuthorityGroupName(java.lang.String value)
value
- The job stream authority group.public void setFreeDaysCalendarKey(CalendarKey key)
key
- The key of the free days calendar used with this job stream.public void setDeadlineSmoothingFactor(int value)
value
- The deadline smoothing factor used with this job stream.public void setDeadlineLimitFeedback(int value)
value
- The deadline limit feedback used with this job stream.public void setModifyData(ModifyData data)
data
- A ModifyData object.public void setLockData(LockData data)
data
- A LockData object.public void setFlowTargetId(Identifier identifier)
identifier
- The identifier of the workstation or workstation class referenced by this job stream.public void setOnRequest(boolean value)
value
- True if this job stream runs on request.public void setHasMonitoredJob(boolean value)
value
- True if this job stream contains a monitored job.public void setSaturdayFree(boolean value)
value
- True if saturday is considered as a free day for this job stream.public void setSundayFree(boolean value)
value
- True if sunday is considered as a free day for this job stream.public void setResolutionData(ResolutionData data)
data
- The default criteria to be used for resolving external dependencies.public void setFreeDaysCalendarId(Identifier identifier)
identifier
- The identifier of the free days calendar used with this job stream.public void replaceLists(JobStream jobStream)
jobStream
- The job stream whose lists of jobs, run cycles and all dependencies must replace the current ones.public boolean equals(java.lang.Object object)
equals
in class FlowNode
object
- The object to be compared with this one.
public int hashCode()
hashCode
in class FlowNode
public java.lang.String toString()
toString
in class FlowNode
|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |