com.ibm.tws.objects.plan
Class JobStreamInPlan

java.lang.Object
  extended bycom.ibm.tws.objects.plan.FlowNodeInPlan
      extended bycom.ibm.tws.objects.plan.JobStreamInPlan
All Implemented Interfaces:
java.io.Serializable, TWSHeader, TWSObject

public class JobStreamInPlan
extends FlowNodeInPlan

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

See Also:
JobStreamInPlanKey, JobInPlan, TimeRestrictions, FlowNodeInternalStatusType, FlowNodeStatusType, JobInPlanZOSAttributes, Serialized Form

Field 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 com.ibm.tws.objects.plan.FlowNodeInPlan
getCpuTime, getDescription, getElapsedTime, getEstimatedDuration, getExternalDependencies, getFileDependencies, getId, getInternalStatus, getInterNetworkDependencies, getKey, getName, getNumberOfFileDependencies, getNumberOfInternetworkDependencies, getNumberOfJobDependencies, getNumberOfJobStreamDependencies, getNumberOfPromptDependencies, getNumberOfResourceDependencies, getNumDependencies, getObjectKey, getOrigPriority, getPriority, getPromptDependencies, getRecordNumber, getResourceDependencies, getStatus, getTimeRestrictions, getTimeStarted, getTimeZone, isMonitored, setCpuTime, setDescription, setElapsedTime, setEstimatedDuration, setId, setInternalStatus, setKey, setMonitored, setName, setNumberOfFileDependencies, setNumberOfInternetworkDependencies, setNumberOfJobDependencies, setNumberOfJobStreamDependencies, setNumberOfPromptDependencies, setNumberOfResourceDependencies, setNumDependencies, setOrigPriority, setPriority, setRecordNumber, setStatus, setTimeRestrictions, setTimeStarted, 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
Constant value used to identify no limit Job Streams

See Also:
Constant Field Values
Constructor Detail

JobStreamInPlan

public JobStreamInPlan(JobStreamInPlanKey key)
Constructor.

Parameters:
key - the Job Stream key.

JobStreamInPlan

public JobStreamInPlan()
Empty Constructor

Method Detail

getObjectHeader

public TWSHeader getObjectHeader()
Returns the the Job Stream header. In this case the objectitself.

Returns:
the object's header.
See Also:
TWSObject.getObjectHeader()

getStartTime

public java.util.Date getStartTime()
Returns the Job Stream Schedule Time

Returns:
the Job Stream Schedule Time

getModifyData

public ModifyData getModifyData()
Returns the object Modify data. For all plan object this method return null.

Returns:
the object's modify data
See Also:
TWSObject.getModifyData()

getLockData

public LockData getLockData()
Returns the object Lock data. For all plan object this method return null.

Returns:
the object's lock data
See Also:
TWSObject.getLockData()

getNumberOfAbendedJob

public int getNumberOfAbendedJob()
Returns the number of abended jobs.

Returns:
the number of abended jobs.

getNumberOfExecutingJob

public int getNumberOfExecutingJob()
Returns the number of executing jobs

Returns:
the number of executing jobs

getNumberOfFailedJob

public int getNumberOfFailedJob()
Returns the number of failed jobs

Returns:
the number of failed jobs

getNumberOfJob

public int getNumberOfJob()
Returns the number of jobs

Returns:
the number of jobs

getNumberOfNotRunningJob

public int getNumberOfNotRunningJob()
Returns the number of not yet started jobs

Returns:
the number of not yet started jobs

getNumberOfSkelJob

public int getNumberOfSkelJob()
Returns the number of still to execute jobs

Returns:
the number of still to execute jobs

getNumberOfSuccessfullJob

public int getNumberOfSuccessfullJob()
Returns the number of successfull jobs

Returns:
the number of successfull jobs

getNumberOfUndecidedJob

public int getNumberOfUndecidedJob()
Returns the number of undecided jobs.

Returns:
The number of undecided jobs.

getProductionDate

public java.util.Date getProductionDate()
Returns the Date when the Job Stream was selected.

Returns:
the Date when the Job Stream was selected.

getLimit

public int getLimit()
Returns the Job Stream limit.

Returns:
the Job Stream limit.

getWorkstationId

public Identifier getWorkstationId()
Returns the referenced Workstation Identifier.

Returns:
the referenced Workstation Identifier.

getWorkstationKey

public WorkstationInPlanKey getWorkstationKey()
Returns the referenced Workstation key.

Returns:
the referenced Workstation key.

getAliasJobStreamName

public java.lang.String getAliasJobStreamName()
Returns the Alias Job Stream name.

Returns:
the Alias Job Stream name.

getOriginalJobStreamName

public java.lang.String getOriginalJobStreamName()
Returns the original Job Stream name.

Returns:
the original Job Stream name.

getWorkstationClass

public java.lang.String getWorkstationClass()
Returns the Job Stream Workstation Class. Manteineid for backward compatibility.

Returns:
the Job Stream Workstation Class.

isAliased

public boolean isAliased()
Returns true if this Job Stream has been aliases, false otherwise

Returns:
true if this Job Stream has been aliases, false otherwise

isCanceled

public boolean isCanceled()
Returns true if this Job Stream has been canceled, false otherwise

Returns:
true if this Job Stream has been canceled, false otherwise

isCarriedForward

public boolean isCarriedForward()
Returns true if this Job Stream has been carried forward, false otherwise

Returns:
true if this Job Stream has been carried forward, false otherwise

isDeadlineUsed

public boolean isDeadlineUsed()
Returns true if in this Job Stream Deadline Date is set, false otherwise

Returns:
true if in this Job Stream Deadline Date is set, false otherwise

isDontTouch

public boolean isDontTouch()
Returns true if in this Job Stream Until Date has passed, false otherwise

Returns:
true if in this Job Stream Until Date has passed, false otherwise

isEvery

public boolean isEvery()
Returns true if this Job Stream contains at least one Job Every, false otherwise

Returns:
true if this Job Stream contains at least one Job Every, false otherwise

isExternal

public boolean isExternal()
Returns true if this Job Stream is external, false otherwise

Returns:
true if this Job Stream is external, false otherwise

isHasInternetworkDependencies

public boolean isHasInternetworkDependencies()
Returns true if this Job Stream has Internetwork Dependency, false otherwise

Returns:
true if this Job Stream has Internetwork Dependency, false otherwise

isHasResources

public boolean isHasResources()
Returns true if this Job Stream owns Resources, false otherwise

Returns:
true if this Job Stream owns Resources, false otherwise

isHeldByUser

public boolean isHeldByUser()
Returns true if this Job Stream has priority set to zero, false otherwise

Returns:
true if this Job Stream has priority set to zero, false otherwise

isInOrder

public boolean isInOrder()
Returns true if this Job Stream is in order, false otherwise

Returns:
true if this Job Stream is in order, false otherwise

isLateJobStream

public boolean isLateJobStream()
Returns true if this Job Stream is Late, false otherwise

Returns:
true if this Job Stream is Late, false otherwise

isNeedResources

public boolean isNeedResources()
Returns true if this Job Stream has Resource Dependencies, false otherwise

Returns:
true if this Job Stream has Resource Dependencies, false otherwise

isPendingCancellation

public boolean isPendingCancellation()
Returns true if this Job Stream is pending cancellation, false otherwise

Returns:
true if this Job Stream is pending cancellation, false otherwise

isReleased

public boolean isReleased()
Returns true if this Job Stream is released, false otherwise

Returns:
true if this Job Stream is released, false otherwise

isReplicated

public boolean isReplicated()
Returns true if this Job Stream is replicated, false otherwise

Returns:
true if this Job Stream is replicated, false otherwise

isCarryForward

public boolean isCarryForward()
Returns true if this Job Stream is to be carried forward, false otherwise

Returns:
true if this Job Stream is to be carried forward, false otherwise

isThisCpu

public boolean isThisCpu()
Returns true if this Job Stream is for this Workstation, false otherwise

Returns:
true if this Job Stream is for this Workstation, false otherwise

isUntilGone

public boolean isUntilGone()
Returns true if the Until Date passed, false otherwise

Returns:
true if the Until Date passed, false otherwise.

isUntilUsed

public boolean isUntilUsed()
Returns true if the Until Date is set, false otherwise

Returns:
true if the Until Date is set, false otherwise

isUserJobs

public boolean isUserJobs()
Returns true if this Job Stream is a USERJOBS, false otherwise

Returns:
true if this Job Stream is a USERJOBS, false otherwise

getGroupName

public java.lang.String getGroupName()
Returns the group name. z/OS only method.

Returns:
the Group name.

getOwnerName

public java.lang.String getOwnerName()
Returns the owner name. z/OS only method.

Returns:
the owner name.

getOwnerDescription

public java.lang.String getOwnerDescription()
Returns the owner description. z/OS only method.

Returns:
the owner description.

getAuthorityGroup

public java.lang.String getAuthorityGroup()
Returns the authority group. z/OS only method.

Returns:
the authority group.

getCalendarKey

public CalendarInPlanKey getCalendarKey()
Returns the calendar. z/OS only method.

Returns:
the calendar.

getVariableTable

public java.lang.String getVariableTable()
Returns the variable table. z/OS only method.

Returns:
the variable tabel.

getZosSpecificAttributes

public JobStreamInPlanZOSAttributes getZosSpecificAttributes()
Returns the Z/OS attributes. z/OS only method.

Returns:
the Z/OS attributes.

getJobs

public java.util.List getJobs()
Returns a reference to the list of jobs included in this job stream. This List is filled only if this Job Stream is the result of a getPlanObject API with some particular Scope. See the attribute documentation for details.

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

setWorkstationKey

public void setWorkstationKey(WorkstationInPlanKey wksKey)
Sets the referenced Workstation key.

Parameters:
wksKey - the referenced Workstation key to set.

setStartTime

public void setStartTime(java.util.Date date)
Sets the Job Stream Schedule Time.

Parameters:
date - the Job Stream Schedule Time to set.

setNumberOfAbendedJob

public void setNumberOfAbendedJob(int i)
Sets the number of abended jobs. For internal use only.

Parameters:
i - the number of abended jobs to set.

setNumberOfExecutingJob

public void setNumberOfExecutingJob(int i)
Sets the number of executing jobs. For internal use only.

Parameters:
i - the number of executing jobs to set.

setNumberOfFailedJob

public void setNumberOfFailedJob(int i)
Sets the number of failed jobs. For internal use only.

Parameters:
i - the number of failed jobs to set.

setNumberOfJob

public void setNumberOfJob(int i)
Sets the number of jobs. For internal use only.

Parameters:
i - the number of jobs to set.

setNumberOfNotRunningJob

public void setNumberOfNotRunningJob(int i)
Sets the number of not yet running jobs. For internal use only.

Parameters:
i - the number of not yet running jobs to set.

setNumberOfSkelJob

public void setNumberOfSkelJob(int i)
Sets the number of not executing jobs. For internal use only.

Parameters:
i - the number of not executing jobs to set.

setNumberOfUndecidedJob

public void setNumberOfUndecidedJob(int i)
Sets the number of undecided jobs. For internal use only.

Parameters:
i - the number of undecided jobs to set.

setNumberOfSuccessfullJob

public void setNumberOfSuccessfullJob(int i)
Sets the number of successfull jobs. For internal use only.

Parameters:
i - the number of successfull jobs to set.

setProductionDate

public void setProductionDate(java.util.Date date)
Sets the Date when the Job Stream was selected. For internal use only.

Parameters:
date - the Date when the Job Stream was selected to set.

setLimit

public void setLimit(int i)
Sets the new Job Stream limit. Valid values are between -1 (NO_LIMIT) and 1024.

Parameters:
i - the Job Stream limit to set.

setWorkstationId

public void setWorkstationId(Identifier identifier)
Sets the referenced Workstation Identifier.

Parameters:
identifier - the referenced Workstation Identifier to set.

setAliasJobStreamName

public void setAliasJobStreamName(java.lang.String string)
Sets an alias for this Job Stream.

Parameters:
string - the alias of this Job Stream to set.

setOriginalJobStreamName

public void setOriginalJobStreamName(java.lang.String string)
Sets the Original Job Stream Name For internal use only.

Parameters:
string - the Original Job Stream Name to set.

setWorkstationClass

public void setWorkstationClass(java.lang.String string)
Sets the Workstation Class of this Job Stream. For internal use only.

Parameters:
string - the Workstation Class of this Job Stream to set.

setAliased

public void setAliased(boolean b)
Sets that this Job Stream has an alias. That is aliasJobStream has been set. Use this method when you would like to specify an alias through setAliasJobStreamName

Parameters:
b - true if an alias should be specified, false otherwise.

setCanceled

public void setCanceled(boolean b)
Sets that this JobStream is canceled. For internal use only.

Parameters:
b - true if the Job Stream is canceled, false otherwise.

setCarriedForward

public void setCarriedForward(boolean b)
Sets that the Job Stream has been carried forward. For internal use only.

Parameters:
b - true if the Job Stream has been carried forward, false otherwise.

setDeadlineUsed

public void setDeadlineUsed(boolean b)
Sets that TimeRestrictions on Deadline Date exists for this Job Stream. Set this to true if you would like to specify a Deadline Date for the Job Stream.

Parameters:
b - true if Deadline Date is set, false otherwise.
See Also:
FlowNodeInPlan, TimeRestrictions

setDontTouch

public void setDontTouch(boolean b)
Sets that Until Date is passed. For internal use only.

Parameters:
b - true if Until Date is passed, false otherwise.

setEvery

public void setEvery(boolean b)
Sets that at least one Job in the Job Stream is every. For internal use only.

Parameters:
b - true if at least one Job in the Job Stream is every.

setExternal

public void setExternal(boolean b)
Sets that Job Stream is external. For internal use only.

Parameters:
b - true if the Job Stream is external, falxe otherwise.

setHasInternetworkDependencies

public void setHasInternetworkDependencies(boolean b)
Sets that the Job Stream has InternetworkDependencyInPlan. For internal use only.

Parameters:
b - true if the Job Stream has InternetworkDependencyInPlan, false otherwise.

setHasResources

public void setHasResources(boolean b)
Sets that the Job Stream owns Resources. For internal use only.

Parameters:
b - true if the Job Stream owns Resources, false otherwise.

setHeldByUser

public void setHeldByUser(boolean b)
Sets that Job Stream has a priority equal to zero or that in any case is hed by the user. For internal use only.

Parameters:
b - true if the Job Stream is held by the user, false otherwise.

setInOrder

public void setInOrder(boolean b)
Sets that the Job Stream is in Order. For internal use only.

Parameters:
b - true if the Job Stream is in order, false otherwise.

setLateJobStream

public void setLateJobStream(boolean b)
Sets that this is a Late Job Stream. For internal use only.

Parameters:
b - true if this is a Late Job Stream, false otherwise.

setNeedResources

public void setNeedResources(boolean b)
Sets that Job Stream has Resource Dependencies. For internal use only.

Parameters:
b - true if the Job Stream has Resource Dependencies, false otherwise.

setPendingCancellation

public void setPendingCancellation(boolean b)
Sets that the Job Stream is pending cancellation. For internal use only.

Parameters:
b - true if the Job Stream is pending cancellation, false otherwise.

setReleased

public void setReleased(boolean b)
Sets that the Job Stream has been released. For internal use only.

Parameters:
b - true if the Job Stream has been released, false otherwise.

setReplicated

public void setReplicated(boolean b)
Sets that the Job Stream has been replicated. For internal use only.

Parameters:
b - true if the Job Stream has been replicated, false otherwise.

setCarryForward

public void setCarryForward(boolean b)
Sets that the Job Stream is to be Carried forward. For internal use only.

Parameters:
b - true if the Job Stream is to be carried forward, false otherwise.

setThisCpu

public void setThisCpu(boolean b)
Sets that this Job Stream is defined on this Workstation. For internal use only.

Parameters:
b - true if this Job Stream is defined on this Workstation.

setUntilGone

public void setUntilGone(boolean b)
Sets that Until Date is passed. For internal use only.

Parameters:
b - true if Until Date is passed, false otherwise.

setUntilUsed

public void setUntilUsed(boolean b)
Sets that TimeRestrictions on Until Date exists for this Job Stream. Set this to true if you would like to specify an Until Date for the Job Stream.

Parameters:
b - true if Until Date is set, false otherwise.
See Also:
FlowNodeInPlan, TimeRestrictions

setUserJobs

public void setUserJobs(boolean b)
Sets that Job Stream is a USERJOBS. For internal use only.

Parameters:
b - true if this Job Stream is a USERJOBS, false otherwise.

setGroupName

public void setGroupName(java.lang.String value)
Returns the group name. For internal use only. z/OS only method.

Parameters:
value - The Group name.

setOwnerName

public void setOwnerName(java.lang.String value)
Returns the owner name. For internal use only. z/OS only method.

Parameters:
value - The owner name.

setOwnerDescription

public void setOwnerDescription(java.lang.String value)
Returns the owner description. For internal use only. z/OS only method.

Parameters:
value - The owner description.

setAuthorityGroup

public void setAuthorityGroup(java.lang.String value)
Returns the authority group. For internal use only. z/OS only method.

Parameters:
value - The authority group.

setCalendarKey

public void setCalendarKey(CalendarInPlanKey value)
Returns the calendar. For internal use only. z/OS only method.

Parameters:
value - The calendar.

setVariableTable

public void setVariableTable(java.lang.String value)
Returns the variable table. For internal use only. z/OS only method.

Parameters:
value - The variable tabel.

setZosSpecificAttributes

public void setZosSpecificAttributes(JobStreamInPlanZOSAttributes value)
Sets the Z/OS attributes. For internal use only. z/OS only method.

Parameters:
value - The Z/OS attributes.

equals

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

Overrides:
equals in class FlowNodeInPlan
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 JobStreamInPlan object.

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

toString

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

Overrides:
toString in class FlowNodeInPlan
Returns:
A text string including all JobStreamInPlan fields.

getJobStreamDbIdentifier

public Identifier getJobStreamDbIdentifier()
Returns the Job Stream Database Identifier. For Internal Use only.

Returns:
the Database Job Stream Identifier.

setJobStreamDbIdentifier

public void setJobStreamDbIdentifier(Identifier identifier)
Sets the Job Stream Database Identifier. For internal use only.

Parameters:
identifier - the Job Stream Database Identifier.

getInternalIdentifier

public Identifier getInternalIdentifier()
Returns the Job Stream Internal Identifier. It can be used for display only purposes, in order to uniquely identify Job Stream with the same name/workstation/Schedule Time.

Returns:
the Job Stream Internal Identifier.

setInternalIdentifier

public void setInternalIdentifier(Identifier identifier)
Sets the Job Stream Internal Identifier. For Internal Use only.

Parameters:
identifier - the Job Stream Internal Identifier to set.

getLtpId

public JobStreamInstanceIdentifier getLtpId()
Returns the LTP Job Stream Identifier. For Internal use Only.

Returns:
the LTP Job Stream Identifier.

setLtpId

public void setLtpId(JobStreamInstanceIdentifier identifier)
Sets the LTP Job Stream Identifier. For Internal Use only.

Parameters:
identifier - the LTP Identifier to set.


Copyright © 2005 IBM All Rights Reserved.