|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.tws.objects.plan.FlowNodeInPlan
com.ibm.tws.objects.plan.JobStreamInPlan
This object represents a job stream instance in plan and includes a list of JobInPlan objects to represent the jobs contained in the stream. It is a subclass of FlowNodeInPlan, through which it wraps JobStreamInPlanKey. A job stream is externally identified by its name, its Schedule Time (AKA Input Arrival Time) date and the referenced workstation, as shown by JobStreamInPlanKey. Note that these three information not always can uniquely identify a Job Stream, then a display only information, the internalIdentifier has been added to let the user identify the different instances. From an API point of view, the correct way to perform operations on Job Streams is by Identifier, then no problems of overlap acn occour. For further details, see TWS 8.3 documentation.
The following syntax validation constraints must be met on JobStreamInPlan objects in distributed environment:
name | The name of an existing Job Stream instance in the plan or |
during submit, in the Database. | |
description | N/A |
elapsedTime | Actual Duration. Read Only. |
priority | Allowed range is from 0 to 101. Default value is 10. |
internalStatus | One of the values exposed by the FlowNodeInternalStatusType class |
and not starting with FLOW_NODE_ZOSSTATUS_ | |
Read Only. | |
status | One of the following values exposed by the FlowNodeStatusType class: |
FlowNodeStatusType.FLOW_NODE_STATUS_COMPLETED | |
FlowNodeStatusType.FLOW_NODE_STATUS_CANCELED | |
FlowNodeStatusType.FLOW_NODE_STATUS_ERROR | |
FlowNodeStatusType.FLOW_NODE_STATUS_STARTED | |
FlowNodeStatusType.FLOW_NODE_STATUS_WAITING | |
The status FlowNodeStatusType.FLOW_NODE_STATUS_UNDECIDED | |
is returned if none of the above are sent from ZOS. | |
Read Only. | |
timeRestrictions | See TimeRestrictions for constraints on this field |
aliasJobStreamName | Optional. |
Alphanumeric characters | |
Starting with alphabetic character | |
'-' and '_' characters allowed | |
Blank spaces not allowed | |
Not longer than 16 characters | |
authorityGroup | N/A |
calendarKey | N/A |
groupName | N/A |
internalIdentifier | Read Only |
jobs | List of JobInPlan. |
Read only during getPlanObject API | |
and makeJobStreamInPlan API. | |
The object returned by this last API | |
can be manipulated before pass them again to | |
the addJobStreamInstance API. | |
jobStreamDbIdentifier | For internal use only |
limit | Valid values between -1 (NO_LIMIT) and 1024. Default NO_LIMIT. |
lockData | N/A |
ltpId | For Internal Use only. |
modifyData | N/A |
numberOfAbendedJob | Read Only. |
numberOfExecutingJob | Read only |
numberOfFailedJob | Read only |
numberOfJob | Read only |
numberOfNotRunningJob | Read only |
numberOfSkelJob | Read only |
numberOfSuccessfullJob | Read only |
numberOfUndecidedJob | Read only |
originaJobStreamName | Read only |
ownerDescription | N/A |
ownerName | N/A |
productionDate | Read Only |
startTime | Input Arrival Time. |
variableTable | N/A |
workstationClass | Read only |
workstationId | Identifier of an existing Workstation. |
workstationKey | Reference to an existing Workstation |
zosSpecificAttributes | N/A |
aliased | True if aliasJobStreamName is not null. |
canceled | Read only |
carriedForward | Read only |
carryForward | Read only |
deadLineUsed | True if Deadline Date is set. |
dontTouch | Read only |
every | Read only |
external | Read only |
hasInternetworkDependencies | Read only |
hasResources | Read only |
heldByUser | Read only |
inOrder | Read only |
lateJobStream | Read only |
needResources | Read only |
pendingCancellation | Read only |
released | Read only |
replicated | Read only |
thisCpu | Read only |
untilGone | Read only |
untilUsed | Read only |
userJobs | Read only |
The following syntax validation constraints must be met on JobStreamInPlan objects in ZOS environment:
name | Always required |
It must match the name of an existing job stream in database | |
description | Not longer than 24 characters |
elapsedTime | Actual Completition - Actual Arrival |
priority | Allowed range is from 1 to 9 |
internalStatus | One of the following values exposed by the FlowNodeInternalStatusType class: |
FlowNodeInternalStatusType.FLOW_NODE_ZOSSTATUS_COMPLETE | |
FlowNodeInternalStatusType.FLOW_NODE_ZOSSTATUS_DELETED | |
FlowNodeInternalStatusType.FLOW_NODE_ZOSSTATUS_ERROR | |
FlowNodeInternalStatusType.FLOW_NODE_ZOSSTATUS_PENDINGPRED | |
FlowNodeInternalStatusType.FLOW_NODE_ZOSSTATUS_STARTED | |
FlowNodeInternalStatusType.FLOW_NODE_ZOSSTATUS_WAITING | |
The status FlowNodeInternalStatusType.FLOW_NODE_ZOSSTATUS_UNDECIDED | |
is returned if none of the above are sent from ZOS. | |
status | One of the following values exposed by the FlowNodeStatusType class: |
FlowNodeStatusType.FLOW_NODE_STATUS_COMPLETED | |
FlowNodeStatusType.FLOW_NODE_STATUS_CANCELED | |
FlowNodeStatusType.FLOW_NODE_STATUS_ERROR | |
FlowNodeStatusType.FLOW_NODE_STATUS_STARTED | |
FlowNodeStatusType.FLOW_NODE_STATUS_WAITING | |
The status FlowNodeStatusType.FLOW_NODE_STATUS_UNDECIDED | |
is returned if none of the above are sent from ZOS. | |
monitored | Monitoring flag. Default value is false. |
This flag is ignored if the version of Tivoli Workload Scheduler for z/OS is prior to 8.1. | |
timeStarted | This is an output parameter. It cannot be changed |
timeRestrictions | See TimeRestrictions for constraints on this field |
aliasJobStreamName | N/A |
authorityGroup | Not longer than 8 characters |
calendarKey | Output only |
groupName | Not longer than 16 characters |
internalIdentifier | N/A |
jobs | Output only |
jobStreamDbIdentifier | N/A |
limit | N/A |
lockData | N/A |
LtpId | N/A |
modifyData | N/A |
numberOfAbendedJob | N/A |
numberOfExecutingJob | Output only |
numberOfFailedJob | Output only |
numberOfJob | Output only |
numberOfNotRunningJob | N/A |
numberOfSkelJob | N/A |
numberOfSuccessfullJob | Output only |
numberOfUndecidedJob | Output only |
originaJobStreamName | N/A |
ownerDescription | Not longer than 24 characters |
ownerName | Not longer than 16 characters |
productionDate | N/A |
startTime | Input Arrival |
variableTable | Not longer than 16 characters |
workstationClass | N/A |
workstationId | N/A |
workstationKey | N/A |
zosSpecificAttributes | See JobInPlanZOSAttributes for constraints on this field. |
aliased | N/A |
canceled | N/A |
carriedForward | N/A |
carryForward | N/A |
deadLineUsed | N/A |
dontTouch | N/A |
every | N/A |
external | N/A |
hasInternetworkDependencies | N/A |
hasResources | N/A |
heldByUser | N/A |
inOrder | N/A |
lateJobStream | N/A |
needResources | N/A |
pendingCancellation | N/A |
released | N/A |
replicated | N/A |
thisCpu | N/A |
untilGone | N/A |
untilUsed | N/A |
userJobs | N/A |
JobStreamInPlanKey
,
JobInPlan
,
TimeRestrictions
,
FlowNodeInternalStatusType
,
FlowNodeStatusType
,
JobInPlanZOSAttributes
,
Serialized FormField Summary | |
---|---|
static java.lang.String |
COPYRIGHT
Copyright. |
static int |
NO_LIMIT
Constant value used to identify no limit Job Streams |
Constructor Summary | |
---|---|
JobStreamInPlan()
Empty Constructor |
|
JobStreamInPlan(JobStreamInPlanKey key)
Constructor. |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object object)
Returns true if all fields of this JobStreamInPlan object are equal to those of the given one. |
java.lang.String |
getAliasJobStreamName()
Returns the Alias Job Stream name. |
java.lang.String |
getAuthorityGroup()
Returns the authority group. |
CalendarInPlanKey |
getCalendarKey()
Returns the calendar. |
java.lang.String |
getGroupName()
Returns the group name. |
Identifier |
getInternalIdentifier()
Returns the Job Stream Internal Identifier. |
java.util.List |
getJobs()
Returns a reference to the list of jobs included in this job stream. |
Identifier |
getJobStreamDbIdentifier()
Returns the Job Stream Database Identifier. |
int |
getLimit()
Returns the Job Stream limit. |
LockData |
getLockData()
Returns the object Lock data. |
JobStreamInstanceIdentifier |
getLtpId()
Returns the LTP Job Stream Identifier. |
ModifyData |
getModifyData()
Returns the object Modify data. |
int |
getNumberOfAbendedJob()
Returns the number of abended jobs. |
int |
getNumberOfExecutingJob()
Returns the number of executing jobs |
int |
getNumberOfFailedJob()
Returns the number of failed jobs |
int |
getNumberOfJob()
Returns the number of jobs |
int |
getNumberOfNotRunningJob()
Returns the number of not yet started jobs |
int |
getNumberOfSkelJob()
Returns the number of still to execute jobs |
int |
getNumberOfSuccessfullJob()
Returns the number of successfull jobs |
int |
getNumberOfUndecidedJob()
Returns the number of undecided jobs. |
TWSHeader |
getObjectHeader()
Returns the the Job Stream header. |
java.lang.String |
getOriginalJobStreamName()
Returns the original Job Stream name. |
java.lang.String |
getOwnerDescription()
Returns the owner description. |
java.lang.String |
getOwnerName()
Returns the owner name. |
java.util.Date |
getProductionDate()
Returns the Date when the Job Stream was selected. |
java.util.Date |
getStartTime()
Returns the Job Stream Schedule Time |
java.lang.String |
getVariableTable()
Returns the variable table. |
java.lang.String |
getWorkstationClass()
Returns the Job Stream Workstation Class. |
Identifier |
getWorkstationId()
Returns the referenced Workstation Identifier. |
WorkstationInPlanKey |
getWorkstationKey()
Returns the referenced Workstation key. |
JobStreamInPlanZOSAttributes |
getZosSpecificAttributes()
Returns the Z/OS attributes. |
int |
hashCode()
Returns a hash code for this JobStreamInPlan object. |
boolean |
isAliased()
Returns true if this Job Stream has been aliases, false otherwise |
boolean |
isCanceled()
Returns true if this Job Stream has been canceled, false otherwise |
boolean |
isCarriedForward()
Returns true if this Job Stream has been carried forward, false otherwise |
boolean |
isCarryForward()
Returns true if this Job Stream is to be carried forward, false otherwise |
boolean |
isDeadlineUsed()
Returns true if in this Job Stream Deadline Date is set, false otherwise |
boolean |
isDontTouch()
Returns true if in this Job Stream Until Date has passed, false otherwise |
boolean |
isEvery()
Returns true if this Job Stream contains at least one Job Every, false otherwise |
boolean |
isExternal()
Returns true if this Job Stream is external, false otherwise |
boolean |
isHasInternetworkDependencies()
Returns true if this Job Stream has Internetwork Dependency, false otherwise |
boolean |
isHasResources()
Returns true if this Job Stream owns Resources, false otherwise |
boolean |
isHeldByUser()
Returns true if this Job Stream has priority set to zero, false otherwise |
boolean |
isInOrder()
Returns true if this Job Stream is in order, false otherwise |
boolean |
isLateJobStream()
Returns true if this Job Stream is Late, false otherwise |
boolean |
isNeedResources()
Returns true if this Job Stream has Resource Dependencies, false otherwise |
boolean |
isPendingCancellation()
Returns true if this Job Stream is pending cancellation, false otherwise |
boolean |
isReleased()
Returns true if this Job Stream is released, false otherwise |
boolean |
isReplicated()
Returns true if this Job Stream is replicated, false otherwise |
boolean |
isThisCpu()
Returns true if this Job Stream is for this Workstation, false otherwise |
boolean |
isUntilGone()
Returns true if the Until Date passed, false otherwise |
boolean |
isUntilUsed()
Returns true if the Until Date is set, false otherwise |
boolean |
isUserJobs()
Returns true if this Job Stream is a USERJOBS, false otherwise |
void |
setAliased(boolean b)
Sets that this Job Stream has an alias. |
void |
setAliasJobStreamName(java.lang.String string)
Sets an alias for this Job Stream. |
void |
setAuthorityGroup(java.lang.String value)
Returns the authority group. |
void |
setCalendarKey(CalendarInPlanKey value)
Returns the calendar. |
void |
setCanceled(boolean b)
Sets that this JobStream is canceled. |
void |
setCarriedForward(boolean b)
Sets that the Job Stream has been carried forward. |
void |
setCarryForward(boolean b)
Sets that the Job Stream is to be Carried forward. |
void |
setDeadlineUsed(boolean b)
Sets that TimeRestrictions on Deadline Date exists for this Job Stream. |
void |
setDontTouch(boolean b)
Sets that Until Date is passed. |
void |
setEvery(boolean b)
Sets that at least one Job in the Job Stream is every. |
void |
setExternal(boolean b)
Sets that Job Stream is external. |
void |
setGroupName(java.lang.String value)
Returns the group name. |
void |
setHasInternetworkDependencies(boolean b)
Sets that the Job Stream has InternetworkDependencyInPlan. |
void |
setHasResources(boolean b)
Sets that the Job Stream owns Resources. |
void |
setHeldByUser(boolean b)
Sets that Job Stream has a priority equal to zero or that in any case is hed by the user. |
void |
setInOrder(boolean b)
Sets that the Job Stream is in Order. |
void |
setInternalIdentifier(Identifier identifier)
Sets the Job Stream Internal Identifier. |
void |
setJobStreamDbIdentifier(Identifier identifier)
Sets the Job Stream Database Identifier. |
void |
setLateJobStream(boolean b)
Sets that this is a Late Job Stream. |
void |
setLimit(int i)
Sets the new Job Stream limit. |
void |
setLtpId(JobStreamInstanceIdentifier identifier)
Sets the LTP Job Stream Identifier. |
void |
setNeedResources(boolean b)
Sets that Job Stream has Resource Dependencies. |
void |
setNumberOfAbendedJob(int i)
Sets the number of abended jobs. |
void |
setNumberOfExecutingJob(int i)
Sets the number of executing jobs. |
void |
setNumberOfFailedJob(int i)
Sets the number of failed jobs. |
void |
setNumberOfJob(int i)
Sets the number of jobs. |
void |
setNumberOfNotRunningJob(int i)
Sets the number of not yet running jobs. |
void |
setNumberOfSkelJob(int i)
Sets the number of not executing jobs. |
void |
setNumberOfSuccessfullJob(int i)
Sets the number of successfull jobs. |
void |
setNumberOfUndecidedJob(int i)
Sets the number of undecided jobs. |
void |
setOriginalJobStreamName(java.lang.String string)
Sets the Original Job Stream Name For internal use only. |
void |
setOwnerDescription(java.lang.String value)
Returns the owner description. |
void |
setOwnerName(java.lang.String value)
Returns the owner name. |
void |
setPendingCancellation(boolean b)
Sets that the Job Stream is pending cancellation. |
void |
setProductionDate(java.util.Date date)
Sets the Date when the Job Stream was selected. |
void |
setReleased(boolean b)
Sets that the Job Stream has been released. |
void |
setReplicated(boolean b)
Sets that the Job Stream has been replicated. |
void |
setStartTime(java.util.Date date)
Sets the Job Stream Schedule Time. |
void |
setThisCpu(boolean b)
Sets that this Job Stream is defined on this Workstation. |
void |
setUntilGone(boolean b)
Sets that Until Date is passed. |
void |
setUntilUsed(boolean b)
Sets that TimeRestrictions on Until Date exists for this Job Stream. |
void |
setUserJobs(boolean b)
Sets that Job Stream is a USERJOBS. |
void |
setVariableTable(java.lang.String value)
Returns the variable table. |
void |
setWorkstationClass(java.lang.String string)
Sets the Workstation Class of this Job Stream. |
void |
setWorkstationId(Identifier identifier)
Sets the referenced Workstation Identifier. |
void |
setWorkstationKey(WorkstationInPlanKey wksKey)
Sets the referenced Workstation key. |
void |
setZosSpecificAttributes(JobStreamInPlanZOSAttributes value)
Sets the Z/OS attributes. |
java.lang.String |
toString()
Returns a string representation of this JobStreamInPlan. |
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 JobStreamInPlan(JobStreamInPlanKey key)
key
- the Job Stream key.public JobStreamInPlan()
Method Detail |
public TWSHeader getObjectHeader()
TWSObject.getObjectHeader()
public java.util.Date getStartTime()
public ModifyData getModifyData()
TWSObject.getModifyData()
public LockData getLockData()
TWSObject.getLockData()
public int getNumberOfAbendedJob()
public int getNumberOfExecutingJob()
public int getNumberOfFailedJob()
public int getNumberOfJob()
public int getNumberOfNotRunningJob()
public int getNumberOfSkelJob()
public int getNumberOfSuccessfullJob()
public int getNumberOfUndecidedJob()
public java.util.Date getProductionDate()
public int getLimit()
public Identifier getWorkstationId()
public WorkstationInPlanKey getWorkstationKey()
public java.lang.String getAliasJobStreamName()
public java.lang.String getOriginalJobStreamName()
public java.lang.String getWorkstationClass()
public boolean isAliased()
public boolean isCanceled()
public boolean isCarriedForward()
public boolean isDeadlineUsed()
public boolean isDontTouch()
public boolean isEvery()
public boolean isExternal()
public boolean isHasInternetworkDependencies()
public boolean isHasResources()
public boolean isHeldByUser()
public boolean isInOrder()
public boolean isLateJobStream()
public boolean isNeedResources()
public boolean isPendingCancellation()
public boolean isReleased()
public boolean isReplicated()
public boolean isCarryForward()
public boolean isThisCpu()
public boolean isUntilGone()
public boolean isUntilUsed()
public boolean isUserJobs()
public java.lang.String getGroupName()
public java.lang.String getOwnerName()
public java.lang.String getOwnerDescription()
public java.lang.String getAuthorityGroup()
public CalendarInPlanKey getCalendarKey()
public java.lang.String getVariableTable()
public JobStreamInPlanZOSAttributes getZosSpecificAttributes()
public java.util.List getJobs()
public void setWorkstationKey(WorkstationInPlanKey wksKey)
wksKey
- the referenced Workstation key to set.public void setStartTime(java.util.Date date)
date
- the Job Stream Schedule Time to set.public void setNumberOfAbendedJob(int i)
i
- the number of abended jobs to set.public void setNumberOfExecutingJob(int i)
i
- the number of executing jobs to set.public void setNumberOfFailedJob(int i)
i
- the number of failed jobs to set.public void setNumberOfJob(int i)
i
- the number of jobs to set.public void setNumberOfNotRunningJob(int i)
i
- the number of not yet running jobs to set.public void setNumberOfSkelJob(int i)
i
- the number of not executing jobs to set.public void setNumberOfUndecidedJob(int i)
i
- the number of undecided jobs to set.public void setNumberOfSuccessfullJob(int i)
i
- the number of successfull jobs to set.public void setProductionDate(java.util.Date date)
date
- the Date when the Job Stream was selected to set.public void setLimit(int i)
i
- the Job Stream limit to set.public void setWorkstationId(Identifier identifier)
identifier
- the referenced Workstation Identifier to set.public void setAliasJobStreamName(java.lang.String string)
string
- the alias of this Job Stream to set.public void setOriginalJobStreamName(java.lang.String string)
string
- the Original Job Stream Name to set.public void setWorkstationClass(java.lang.String string)
string
- the Workstation Class of this Job Stream to set.public void setAliased(boolean b)
b
- true if an alias should be specified, false otherwise.public void setCanceled(boolean b)
b
- true if the Job Stream is canceled, false otherwise.public void setCarriedForward(boolean b)
b
- true if the Job Stream has been carried forward, false otherwise.public void setDeadlineUsed(boolean b)
b
- true if Deadline Date is set, false otherwise.FlowNodeInPlan
,
TimeRestrictions
public void setDontTouch(boolean b)
b
- true if Until Date is passed, false otherwise.public void setEvery(boolean b)
b
- true if at least one Job in the Job Stream is every.public void setExternal(boolean b)
b
- true if the Job Stream is external, falxe otherwise.public void setHasInternetworkDependencies(boolean b)
b
- true if the Job Stream has InternetworkDependencyInPlan, false otherwise.public void setHasResources(boolean b)
b
- true if the Job Stream owns Resources, false otherwise.public void setHeldByUser(boolean b)
b
- true if the Job Stream is held by the user, false otherwise.public void setInOrder(boolean b)
b
- true if the Job Stream is in order, false otherwise.public void setLateJobStream(boolean b)
b
- true if this is a Late Job Stream, false otherwise.public void setNeedResources(boolean b)
b
- true if the Job Stream has Resource Dependencies, false otherwise.public void setPendingCancellation(boolean b)
b
- true if the Job Stream is pending cancellation, false otherwise.public void setReleased(boolean b)
b
- true if the Job Stream has been released, false otherwise.public void setReplicated(boolean b)
b
- true if the Job Stream has been replicated, false otherwise.public void setCarryForward(boolean b)
b
- true if the Job Stream is to be carried forward, false otherwise.public void setThisCpu(boolean b)
b
- true if this Job Stream is defined on this Workstation.public void setUntilGone(boolean b)
b
- true if Until Date is passed, false otherwise.public void setUntilUsed(boolean b)
b
- true if Until Date is set, false otherwise.FlowNodeInPlan
,
TimeRestrictions
public void setUserJobs(boolean b)
b
- true if this Job Stream is a USERJOBS, false otherwise.public void setGroupName(java.lang.String value)
value
- The Group name.public void setOwnerName(java.lang.String value)
value
- The owner name.public void setOwnerDescription(java.lang.String value)
value
- The owner description.public void setAuthorityGroup(java.lang.String value)
value
- The authority group.public void setCalendarKey(CalendarInPlanKey value)
value
- The calendar.public void setVariableTable(java.lang.String value)
value
- The variable tabel.public void setZosSpecificAttributes(JobStreamInPlanZOSAttributes value)
value
- The Z/OS attributes.public boolean equals(java.lang.Object object)
equals
in class FlowNodeInPlan
object
- The object to be compared with this one.
public int hashCode()
hashCode
in class FlowNodeInPlan
public java.lang.String toString()
toString
in class FlowNodeInPlan
public Identifier getJobStreamDbIdentifier()
public void setJobStreamDbIdentifier(Identifier identifier)
identifier
- the Job Stream Database Identifier.public Identifier getInternalIdentifier()
public void setInternalIdentifier(Identifier identifier)
identifier
- the Job Stream Internal Identifier to set.public JobStreamInstanceIdentifier getLtpId()
public void setLtpId(JobStreamInstanceIdentifier identifier)
identifier
- the LTP Identifier to set.
|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |