com.ibm.tws.objects.plan
Class JobInPlan

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

public class JobInPlan
extends FlowNodeInPlan

This subclass of FlowNodeInPlan represents a job instance object, and includes a reference to JobDefinitionInPlan, and a list of InternalDependencyInPlan objects, to model dependencies of this job instance from other jobs of the same job stream instance. It wraps a JobInPlanKey through FlowNodeKey. A job is externally identified by its name and by the job stream to which it belongs, as shown by the JobInPlanKey.

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

name The name of an existing Job instance in the plan.
During submit it should respect the following constraints:
Alphanumeric characters
Starting with alphabetic character
'-' and '_' characters allowed
Blank spaces not allowed
Not longer than 40 characters.
It will be the alias Job name.
description N/A
elapsedTime Actual Duration
Read only value.
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 value.
status One of the values exposed by the FlowNodeStatusType class:
FlowNodeStatusType.FLOW_NODE_STATUS_WAITING
FlowNodeStatusType.FLOW_NODE_STATUS_READY
FlowNodeStatusType.FLOW_NODE_STATUS_BLOCKED
FlowNodeStatusType.FLOW_NODE_STATUS_STARTED
FlowNodeStatusType.FLOW_NODE_STATUS_COMPLETED
FlowNodeStatusType.FLOW_NODE_STATUS_CANCELED
FlowNodeStatusType.FLOW_NODE_STATUS_ERROR
FlowNodeStatusType.FLOW_NODE_STATUS_HELD
The status FlowNodeStatusType.FLOW_NODE_STATUS_UNDECIDED
is returned if none of the above are sent.
Read only value.
timeRestrictions See TimeRestrictions for constraints on this field
externalSuccessor N/A.
internalDependencies See ExternalDependencyInPlan for constraints on this field.
Even if no External Dependency are present the List is allocated but empty.
internalSuccessor N/A.
jobDefinition See DistJobDefinitionInPlan for constraints on this field.
jobDefinitionId Job Definition Identifier. See DistJobDefinitionInPlan
for constraints on Job Definition with this Identifier.
jobNumber Read only value.
jobRerunSequence Read only value.
jobStreamId Identifier of the referenced Job Stream
jobStreamKey Reference to an existing JobStreamInPlan
lockData N/A
modifyData N/A
repeatInterval Default value is -1. if the specified value is greater
than 0 but less than 1 minute, one minute is used.
zosSpecificAttributes N/A.
requiresConfirmation Read only value.
dontTouch Read only value.
untilUsed Default value is false.
userJob Read only value.
successPending Read only value.
needMessage Read only value.
needResource Read only value.
hasResource Read only value.
released Read only value.
canceled Read only value.
every Default value is false.
buckujob Read only value.
rerunJob Read only value.
recoveryRerunJob Read only value.
userRerunAgain Read only value.
running Read only value.
wildcarded Read only value.
aliased Default value is false.
restarted Read only value.
replicated Read only value.
pendingCacellation Read only value.
everyRerun Read only value.
programmatic Read only value.
interactive Read only value.
rerunStep Read only value.
external Read only value.
heldByUser Read only value.
centralized The job is a TWS z/OS End-to-end centralized job. Read only value.
centralizedSatisfied The job is a TWS z/OS End-to-end centralized job, the related script has been downloaded and the job should be ready to start.
untilGone Read only value.
deadlineUsed Default value is false.
jobLate Read only value.

The following syntax validation constraints must be met on JobInPlan objects in zOS environment:

name Always required
It must be an integer number. Allowed range is from 1 to 999
description Not longer than 24 characters
elapsedTime Actual Duration
In recovery JobInPlan: Recovery Job Duration
priority Allowed range is from 1 to 9
internalStatus One of the following values exposed by the FlowNodeInternalStatusType class:
FlowNodeInternalStatusType.FLOW_NODE_ZOSSTATUS_WAITINGFORINPUT
FlowNodeInternalStatusType.FLOW_NODE_ZOSSTATUS_READY
FlowNodeInternalStatusType.FLOW_NODE_ZOSSTATUS_STARTED
FlowNodeInternalStatusType.FLOW_NODE_ZOSSTATUS_COMPLETE
FlowNodeInternalStatusType.FLOW_NODE_ZOSSTATUS_DELETED
FlowNodeInternalStatusType.FLOW_NODE_ZOSSTATUS_INTERRUPTED
FlowNodeInternalStatusType.FLOW_NODE_ZOSSTATUS_NOREPORTINGPRED
FlowNodeInternalStatusType.FLOW_NODE_ZOSSTATUS_ERROR
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 values exposed by the FlowNodeStatusType class:
FlowNodeStatusType.FLOW_NODE_STATUS_WAITING
FlowNodeStatusType.FLOW_NODE_STATUS_READY
FlowNodeStatusType.FLOW_NODE_STATUS_STARTED
FlowNodeStatusType.FLOW_NODE_STATUS_COMPLETED
FlowNodeStatusType.FLOW_NODE_STATUS_CANCELED
FlowNodeStatusType.FLOW_NODE_STATUS_ERROR
FlowNodeStatusType.FLOW_NODE_STATUS_HELD
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 zOS is prior to 8.1.
timeStarted Date and time when the job has started its execution
timeRestrictions See TimeRestrictions for constraints on this field
externalSuccessor List of successor jobs belonging to other job stream . This list is a read only list.
This list is not used when creating a new JobInPlan or modifying an existing JobInPlan in the TWS z/OS Plan
internalDependencies List of jobs belonging to same job stream . This list is a read only list.
This list is not used when creating a new JobInPlan or modifying an existing JobInPlan in the TWS z/OS Plan.
internalSuccessor List of successor jobs belonging to same job stream . This list is a read only list..
This list is not used when creating a new JobInPlan or modifying an existing JobInPlan in the TWS z/OS Plan.
jobDefinition See ZOSJobDefinitionInPlan for constraints on this field.
jobDefinitionId Job Definition ID. See ZOSJobDefinitionInPlan for constraints on Job Definition with this ID.
jobStreamId Identifier of the referenced Job Stream
jobStreamKey Reference to an existing JobStreamInPlan
jobNumber N/A
jobRerunSequence N/A
lockData N/A
modifyData N/A
objectHeader N/A
repeatInterval N/A
zosSpecificAttributes See JobInPlanZOSAttributes for constraints on this field.

See Also:
FlowNodeInPlan, JobStreamInPlan, InternalDependencyInPlan, TimeRestrictions, FlowNodeInternalStatusType, FlowNodeStatusType, JobInPlanZOSAttributes, OperatorInstructionInPlan, ZOSJobDefinitionInPlan, Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          Copyright.
 
Constructor Summary
JobInPlan()
          Creates an empty JobInPlan.
JobInPlan(JobInPlanKey key)
          Creates a JobInPlan.
 
Method Summary
 boolean equals(java.lang.Object object)
          Returns true if all fields of this JobInPlan object are equal to those of the given one.
 java.util.List getExternalSuccessors()
          Returns a reference to the list of external successor for this job.
 java.util.List getInternalDependencies()
          Returns a reference to the list of InternalDependencyInPlan for this job.
 java.util.List getInternalSuccessors()
          Returns a reference to the list of internal successor for this job.
 JobDefinitionInPlan getJobDefinition()
          Returns the Job Definition to which this Job refers.
 Identifier getJobDefinitionId()
          Returns the Job Definition Identifier to which this Job Definition refers.
 int getJobNumber()
          Returns the Job Number.
 int getJobRerunSequence()
          Gets the Job Rerun Sequence in the Rerun chain.
 Identifier getJobStreamId()
          Returns the Job Stream Identifier.
 JobStreamInPlanKey getJobStreamKey()
          Returns the key of the job stream that includes this job.
 LockData getLockData()
          Returns the object's lock data (null)
 ModifyData getModifyData()
          Returns the object's modify data (null)
 TWSHeader getObjectHeader()
          Returns the object header.
 long getRepeatInterval()
          Returns the Job Repeat Interval, that is the time interval (in Milliseconds) that will pass between every job execution for Jobs in every.
 JobInPlanZOSAttributes getZosSpecificAttributes()
          Returns the Z/OS attributes.
 int hashCode()
          Returns a hash code for this JobInPlan object.
 boolean isAliased()
          Returns true if this Job is aliased, false otherwise.
 boolean isBuckujob()
          Returns true if Job is a $USERJOB, false otherwise.
 boolean isCanceled()
          Returns true if the Job has been canceled, false otherwise
 boolean isCentralized()
          Centralized scripts (TWS for z/OS).
 boolean isCentralizedSatisfied()
          Centralized scripts satisfied (TWS for z/OS).
 boolean isDeadlineUsed()
          Returns true if Deadline time exists, false otherwise.
 boolean isDontTouch()
          Returns true if Until time passed, false otherwise.
 boolean isEvery()
          Returns true if Job is a every Job, false otherwise.
 boolean isEveryRerun()
          Returns true if the Job is a every rerun job, false otherwise.
 boolean isExternal()
          Returns true if the Job is an external job (internetwork), false otherwise.
 boolean isHasResource()
          Returns true if Job owns resources, false otherwise.
 boolean isHeldByUser()
          Returns true if Job is held by user, i.e.
 boolean isInteractive()
          Deprecated.  
 boolean isJobLate()
          Returns true if Job is a Late Job, false otherwise.
 boolean isLastInRerunChain()
          Returns true if this job is the last in a rerun chain, false otherwise.
 boolean isNeedMessage()
          Returns true if Recovery prompt needs a reply, false otherwise.
 boolean isNeedResource()
          Returns true if Job Requires resources, false otherwise.
 boolean isPendingCacellation()
          Returns true if the Job is pending cancelation, false otherwise.
 boolean isProgrammatic()
          Returns true if the Job is a Programmatic Job, false otherwise.
 boolean isRecoveryRerunJob()
          Returns true if the Job is a Recovery rerun job, false otherwise.
 boolean isReleased()
          Returns true if the Job has been released, false otherwise.
 boolean isReplicated()
          Returns true if the Job is part of a replicated Job Stream, false otherwise.
 boolean isRequiresConfirmation()
          Returns true if this job requires confirmation, false otherwise.
 boolean isRerunJob()
          Returns true if the Job is a rerun job, false otherwise.
 boolean isRerunStep()
          Returns true if the Job is a rerun job with step name, false otherwise.
 boolean isRestarted()
          Returns true if the Job is a rerun job, false otherwise.
 boolean isRunning()
          Returns true if the Job is counted as running, false otherwise.
 boolean isSuccessPending()
          Returns true if the Job Succeeded but is still running, false otherwise.
 boolean isUntilGone()
          Returns true if Until time passed, false otherwise.
 boolean isUntilUsed()
          Returns true if Until time exists, false otherwise.
 boolean isUserJob()
          Returns true if the Job is a USERJOB, false otherwise.
 boolean isUserRerunAgain()
          Returns true if the Job is a Userjob that will run again, false otherwise.
 boolean isWildcarded()
          Returns true if the Job is wildcarded, false otherwise.
 boolean requiresConfirmation()
          Deprecated. use isRequiresConfirmation instead.
 void setAliased(boolean b)
          Sets the alias Flag.
 void setBuckujob(boolean b)
          Sets the buckujob flag For internal use only.
 void setCanceled(boolean b)
          Sets the canceled flag.
 void setCentralized(boolean b)
          Sets the centralized flag (TWS for z/OS).
 void setCentralizedSatisfied(boolean b)
          Sets the centralized satisfied flag (TWS for z/OS).
 void setDeadlineUsed(boolean b)
          Sets the deadline used flag.
 void setDontTouch(boolean b)
          Sets the don't touch flag.
 void setEvery(boolean b)
          Sets the every flag.
 void setEveryRerun(boolean b)
          Sets the every rerun flag For internal use only.
 void setExternal(boolean b)
          Sets the external flag.
 void setHasResource(boolean b)
          Sets the has resource flag.
 void setHeldByUser(boolean b)
          Sets the held by user flag.
 void setInteractive(boolean b)
          Deprecated.  
 void setJobDefinition(JobDefinitionInPlan plan)
          Sets the Job Definition of this Job.
 void setJobDefinitionId(Identifier identifier)
          Sets the Job Definition Identifier of this Job.
 void setJobLate(boolean b)
          Sets the job late flag For internal use only.
 void setJobNumber(int l)
          Sets the Job Number.
 void setJobRerunSequence(int i)
          Sets Job Rerun Sequence in rerun chains.
 void setJobStreamId(Identifier identifier)
          Sets the Job Stream Identifier.
 void setJobStreamKey(JobStreamInPlanKey jstKey)
          Sets the key of the job stream that includes this job.
 void setLastInRerunChain(boolean b)
          Sets the last in rerun chain value.
 void setNeedMessage(boolean b)
          Sets the need message flag.
 void setNeedResource(boolean b)
          Sets the need resource flag.
 void setPendingCacellation(boolean b)
          Sets the pending cancellation flag For internal use only.
 void setProgrammatic(boolean b)
          Sets the programmatic flag For internal use only.
 void setRecoveryRerunJob(boolean b)
          Sets the recovery rerun flag For internal use only.
 void setReleased(boolean b)
          Sets the released flag For internal use only.
 void setRepeatInterval(long l)
          Sets the Repeat Interval of this Job (in Milliseconds).
 void setReplicated(boolean b)
          Sets the replicated flag.
 void setRequiresConfirmation(boolean b)
          Sets the Requires Confirmation flag.
 void setRerunJob(boolean b)
          Sets the rerun job flag For internal use only.
 void setRerunStep(boolean b)
          Sets the rerun step flag For internal use only.
 void setRestarted(boolean b)
          Sets the restarted flag.
 void setRunning(boolean b)
          Sets the running flag.
 void setSuccessPending(boolean b)
          Sets the success pending flag.
 void setUntilGone(boolean b)
          Sets the Until gone flag For internal use only.
 void setUntilUsed(boolean b)
          Sets the Until Used flag.
 void setUserJob(boolean b)
          Sets the user job flag For internal use only.
 void setUserRerunAgain(boolean b)
          Sets the user rerun again flag.
 void setWildcarded(boolean b)
          Sets the wildcarded flag For internal use only.
 void setZosSpecificAttributes(JobInPlanZOSAttributes value)
          Sets the Z/OS attributes.
 java.lang.String toString()
          Returns a string representation of this JobInPlan.
 
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.

Constructor Detail

JobInPlan

public JobInPlan()
Creates an empty JobInPlan.


JobInPlan

public JobInPlan(JobInPlanKey key)
Creates a JobInPlan.

Parameters:
key - the Job key
Method Detail

getObjectHeader

public TWSHeader getObjectHeader()
Returns the object header.

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

getJobStreamKey

public JobStreamInPlanKey getJobStreamKey()
Returns the key of the job stream that includes this job.

Returns:
The key of the job stream that includes this job.

getModifyData

public ModifyData getModifyData()
Returns the object's modify data (null)

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

getLockData

public LockData getLockData()
Returns the object's lock data (null)

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

getJobStreamId

public Identifier getJobStreamId()
Returns the Job Stream Identifier. The Job Stream is the one to which this Job belongs.

Returns:
The Job Stream Identifier.

getJobDefinition

public JobDefinitionInPlan getJobDefinition()
Returns the Job Definition to which this Job refers.

Returns:
The Job Definition.

getJobDefinitionId

public Identifier getJobDefinitionId()
Returns the Job Definition Identifier to which this Job Definition refers.

Returns:
The Job Definition Identifier.

getRepeatInterval

public long getRepeatInterval()
Returns the Job Repeat Interval, that is the time interval (in Milliseconds) that will pass between every job execution for Jobs in every.

Returns:
the Job repeat interval.

requiresConfirmation

public boolean requiresConfirmation()
Deprecated. use isRequiresConfirmation instead.

Returns true if this job requires confirmation, false otherwise.

Returns:
true if this job requires confirmation, false otherwise.

getJobNumber

public int getJobNumber()
Returns the Job Number.

Returns:
the Job Number.

getJobRerunSequence

public int getJobRerunSequence()
Gets the Job Rerun Sequence in the Rerun chain.

Returns:
the Job rerun Sequence.

isAliased

public boolean isAliased()
Returns true if this Job is aliased, false otherwise.

Returns:
true if this Job is aliased, false otherwise.

isBuckujob

public boolean isBuckujob()
Returns true if Job is a $USERJOB, false otherwise.

Returns:
true if Job is a $USERJOB, false otherwise

isCanceled

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

Returns:
Job has been canceled

isCentralized

public boolean isCentralized()
Centralized scripts (TWS for z/OS).

Returns:
true if the Jobs is centralized, false otherwise.

isCentralizedSatisfied

public boolean isCentralizedSatisfied()
Centralized scripts satisfied (TWS for z/OS).

Returns:
true if the Jobs is centralized satisfied, false otherwise.

isDeadlineUsed

public boolean isDeadlineUsed()
Returns true if Deadline time exists, false otherwise.

Returns:
true if Deadline time exists, false otherwise.

isDontTouch

public boolean isDontTouch()
Returns true if Until time passed, false otherwise.

Returns:
true if Until time passed, false otherwise.

isEvery

public boolean isEvery()
Returns true if Job is a every Job, false otherwise. If true the Job will be re-run every repeatInterval Milliseconds.

Returns:
Returns true if Job is a every Job, false otherwise.

isExternal

public boolean isExternal()
Returns true if the Job is an external job (internetwork), false otherwise.

Returns:
true if the Job is an external job (internetwork), false otherwise.

isHasResource

public boolean isHasResource()
Returns true if Job owns resources, false otherwise.

Returns:
true if Job owns resources, false otherwise.

isHeldByUser

public boolean isHeldByUser()
Returns true if Job is held by user, i.e. priority has been set to 0, false otherwise

Returns:
true if Job is held by user, i.e. priority has been set to 0, false otherwise

isInteractive

public boolean isInteractive()
Deprecated.  

Returns true if Job is an interactive job (Windows only), false otherwise.

Returns:
true if Job is an interactive job (Windows only), false otherwise.

isJobLate

public boolean isJobLate()
Returns true if Job is a Late Job, false otherwise.

Returns:
true if Job is a Late Job, false otherwise.

isNeedMessage

public boolean isNeedMessage()
Returns true if Recovery prompt needs a reply, false otherwise.

Returns:
true if Recovery prompt needs a reply, false otherwise.

isNeedResource

public boolean isNeedResource()
Returns true if Job Requires resources, false otherwise.

Returns:
true if Job Requires resources, false otherwise.

isPendingCacellation

public boolean isPendingCacellation()
Returns true if the Job is pending cancelation, false otherwise.

Returns:
true if the Job is pending cancelation, false otherwise.

isProgrammatic

public boolean isProgrammatic()
Returns true if the Job is a Programmatic Job, false otherwise.

Returns:
true if the Job is a Programmatic Job, false otherwise.

isRecoveryRerunJob

public boolean isRecoveryRerunJob()
Returns true if the Job is a Recovery rerun job, false otherwise.

Returns:
true if the Job is a Recovery rerun job, false otherwise.

isReleased

public boolean isReleased()
Returns true if the Job has been released, false otherwise.

Returns:
true if the Job has been released, false otherwise.

isReplicated

public boolean isReplicated()
Returns true if the Job is part of a replicated Job Stream, false otherwise.

Returns:
true if the Job is part of a replicated Job Stream, false otherwise.

isRerunJob

public boolean isRerunJob()
Returns true if the Job is a rerun job, false otherwise.

Returns:
true if the Job is a rerun job, false otherwise.

isRerunStep

public boolean isRerunStep()
Returns true if the Job is a rerun job with step name, false otherwise.

Returns:
true if the Job is a rerun job with step name, false otherwise.

isRestarted

public boolean isRestarted()
Returns true if the Job is a rerun job, false otherwise.

Returns:
true if the Job is a rerun job, false otherwise.

isRunning

public boolean isRunning()
Returns true if the Job is counted as running, false otherwise.

Returns:
true if the Job is counted as running, false otherwise.

isSuccessPending

public boolean isSuccessPending()
Returns true if the Job Succeeded but is still running, false otherwise.

Returns:
true if the Job Succeeded but is still running, false otherwise.

isUntilGone

public boolean isUntilGone()
Returns true if Until time passed, false otherwise.

Returns:
true if Until time passed, false otherwise.

isUntilUsed

public boolean isUntilUsed()
Returns true if Until time exists, false otherwise.

Returns:
true if Until time exists, false otherwise.

isUserJob

public boolean isUserJob()
Returns true if the Job is a USERJOB, false otherwise.

Returns:
true if the Job is a USERJOB, false otherwise.

isUserRerunAgain

public boolean isUserRerunAgain()
Returns true if the Job is a Userjob that will run again, false otherwise.

Returns:
true if the Job is a Userjob that will run again, false otherwise.

isWildcarded

public boolean isWildcarded()
Returns true if the Job is wildcarded, false otherwise.

Returns:
true if the Job is wildcarded, false otherwise.

getInternalDependencies

public java.util.List getInternalDependencies()
Returns a reference to the list of InternalDependencyInPlan for this job. If this job has no internal dependency, this method returns an empty List.

Returns:
A reference to the list of InternalDependencyInPlan for this job.

getInternalSuccessors

public java.util.List getInternalSuccessors()
Returns a reference to the list of internal successor for this job. z/OS only method.

Returns:
A reference to the list of internal successor for this job.

getExternalSuccessors

public java.util.List getExternalSuccessors()
Returns a reference to the list of external successor for this job. z/OS only method.

Returns:
A reference to the list of external successor for this job.

getZosSpecificAttributes

public JobInPlanZOSAttributes getZosSpecificAttributes()
Returns the Z/OS attributes.

Returns:
the Z/OS attributes.

setJobStreamId

public void setJobStreamId(Identifier identifier)
Sets the Job Stream Identifier. This Job Stream is the one to which this Job belongs.

Parameters:
identifier - The Job Stream Identifier.

setRepeatInterval

public void setRepeatInterval(long l)
Sets the Repeat Interval of this Job (in Milliseconds).

Parameters:
l - the Repeat Interval of this Job (in Milliseconds)

setRequiresConfirmation

public void setRequiresConfirmation(boolean b)
Sets the Requires Confirmation flag. For Internal Use Only.

Parameters:
b - the requires Confirmation flag to set.

setJobDefinition

public void setJobDefinition(JobDefinitionInPlan plan)
Sets the Job Definition of this Job.

Parameters:
plan - the Job Definition to set.

setJobDefinitionId

public void setJobDefinitionId(Identifier identifier)
Sets the Job Definition Identifier of this Job.

Parameters:
identifier - the Job Definition Identifier.

setJobStreamKey

public void setJobStreamKey(JobStreamInPlanKey jstKey)
Sets the key of the job stream that includes this job.

Parameters:
jstKey - The key of the job stream that includes this job.

setJobNumber

public void setJobNumber(int l)
Sets the Job Number. For internal use only.

Parameters:
l - the Job Number to set.

setJobRerunSequence

public void setJobRerunSequence(int i)
Sets Job Rerun Sequence in rerun chains. For internal use only.

Parameters:
i - the Job Rerun Sequence to set.

setAliased

public void setAliased(boolean b)
Sets the alias Flag. Set it to true if you would like to specify an alias for this Job.

Parameters:
b - the value of the alias flag to set.

setBuckujob

public void setBuckujob(boolean b)
Sets the buckujob flag For internal use only.

Parameters:
b - the buckujob flag to set.

setCanceled

public void setCanceled(boolean b)
Sets the canceled flag. For internal use only.

Parameters:
b - the canceled flag to set.

setCentralized

public void setCentralized(boolean b)
Sets the centralized flag (TWS for z/OS). For internal use only.

Parameters:
b - the centralized flag to set

setCentralizedSatisfied

public void setCentralizedSatisfied(boolean b)
Sets the centralized satisfied flag (TWS for z/OS). For internal use only.

Parameters:
b - the centralized satisfied flag to set

setDeadlineUsed

public void setDeadlineUsed(boolean b)
Sets the deadline used flag. Specify it if you would like to specify a Deadline Date.

Parameters:
b - The deadline used flag to set.

setDontTouch

public void setDontTouch(boolean b)
Sets the don't touch flag. For internal use only.

Parameters:
b - the don't touch flag to set.

setEvery

public void setEvery(boolean b)
Sets the every flag. Set it to true if you would like to specify that this job is a 'every' job, with a repeatInterval expressed in Milliseconds.

Parameters:
b - the every flags to set.

setExternal

public void setExternal(boolean b)
Sets the external flag. For internal use only.

Parameters:
b - the external flag to set.

setHasResource

public void setHasResource(boolean b)
Sets the has resource flag. For internal use only.

Parameters:
b - the has resource flag to set.

setHeldByUser

public void setHeldByUser(boolean b)
Sets the held by user flag. For internal use only.

Parameters:
b - the held by user flag to set.

setInteractive

public void setInteractive(boolean b)
Deprecated.  

Sets the interactive flag. Set it to true if this Job should be interactive (Windows only).

Parameters:
b - the interactive flag to set.

setJobLate

public void setJobLate(boolean b)
Sets the job late flag For internal use only.

Parameters:
b - the job late flag to set.

setNeedMessage

public void setNeedMessage(boolean b)
Sets the need message flag. For internal use only.

Parameters:
b - the need message flag to set.

setNeedResource

public void setNeedResource(boolean b)
Sets the need resource flag. For internal use only.

Parameters:
b - the need resource flag to set.

setPendingCacellation

public void setPendingCacellation(boolean b)
Sets the pending cancellation flag For internal use only.

Parameters:
b - the pending cancellation flag to set.

setProgrammatic

public void setProgrammatic(boolean b)
Sets the programmatic flag For internal use only.

Parameters:
b - the programmatic flag to set.

setRecoveryRerunJob

public void setRecoveryRerunJob(boolean b)
Sets the recovery rerun flag For internal use only.

Parameters:
b - the recovery rerun flag to set.

setReleased

public void setReleased(boolean b)
Sets the released flag For internal use only.

Parameters:
b - the released flag to set.

setReplicated

public void setReplicated(boolean b)
Sets the replicated flag. For internal use only.

Parameters:
b - the replicated flag to set.

setRerunJob

public void setRerunJob(boolean b)
Sets the rerun job flag For internal use only.

Parameters:
b - the rerun job to set

setRerunStep

public void setRerunStep(boolean b)
Sets the rerun step flag For internal use only.

Parameters:
b - the rerun step to set.

setRestarted

public void setRestarted(boolean b)
Sets the restarted flag. For internal use only.

Parameters:
b - the restarted flag to set.

setRunning

public void setRunning(boolean b)
Sets the running flag. For internal use only.

Parameters:
b - the running flag to set.

setSuccessPending

public void setSuccessPending(boolean b)
Sets the success pending flag. For internal use only.

Parameters:
b - the success pending flag to set.

setUntilGone

public void setUntilGone(boolean b)
Sets the Until gone flag For internal use only.

Parameters:
b - the Until gone flag to set.

setUntilUsed

public void setUntilUsed(boolean b)
Sets the Until Used flag. Set this flag to true if you would like to specify an Until Date for this Job.

Parameters:
b - the Until Used flag to set.

setUserJob

public void setUserJob(boolean b)
Sets the user job flag For internal use only.

Parameters:
b - the user job flag to set.

setUserRerunAgain

public void setUserRerunAgain(boolean b)
Sets the user rerun again flag. For internal use only.

Parameters:
b - the user rerun again flag to set.

setWildcarded

public void setWildcarded(boolean b)
Sets the wildcarded flag For internal use only.

Parameters:
b - the wildcarded flag to set.

isRequiresConfirmation

public boolean isRequiresConfirmation()
Returns true if this job requires confirmation, false otherwise.

Returns:
true if this job requires confirmation, false otherwise.

isEveryRerun

public boolean isEveryRerun()
Returns true if the Job is a every rerun job, false otherwise.

Returns:
true if the Job is a every rerun job, false otherwise.

setEveryRerun

public void setEveryRerun(boolean b)
Sets the every rerun flag For internal use only.

Parameters:
b - the every rerun flag to set.

setZosSpecificAttributes

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

Parameters:
value - The Z/OS attributes.

equals

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

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

toString

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

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

isLastInRerunChain

public boolean isLastInRerunChain()
Returns true if this job is the last in a rerun chain, false otherwise. If this job is not an 'every' job, but a single job, it returns true. For Internal Use Only.

Returns:
true if this job is the last in a rerun chain, false otherwise.

setLastInRerunChain

public void setLastInRerunChain(boolean b)
Sets the last in rerun chain value. For Internal Use Only

Parameters:
b - the last in rerun chain value to set.


Copyright © 2005 IBM All Rights Reserved.