|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.tws.objects.model.JobDefinition
com.ibm.tws.objects.model.DistJobDefinition
This object, representing a job definition in the TWS distributed environment, references a recovery job definition and a Prompt object, to optionally define a recovery message (also called "abend prompt").
The following syntax validation constraints must be met on DistJobDefinition objects:
name | Always required |
Alphanumeric characters | |
Starting with alphabetic character | |
'-' and '_' characters allowed | |
Blank spaces not allowed | |
Not longer than 40 characters | |
flowTargetKey | Must reference an existing workstation or class |
description | Not longer than 120 characters |
taskType | Not longer than 50 characters |
Default value is calculated as described below | |
command | Default value is false |
userLogin | Always required |
Not longer than 47 characters | |
recoveryJobKey | If specified, must reference an existing job definition |
taskString | Always required |
Not longer than 4095 characters | |
returnCodeMapping | A boolean expression including comparison operators |
Not longer than 256 characters | |
interactive | Default value is false |
Ignored if taskType is other than WINDOWSTASK | |
recoveryOption | One of the values exposed by the RecoveryOption class |
Always required | |
Default value is STOP | |
abendPrompt | If specified, the text must not be longer than 64 characters |
The assignment of a value to the taskType field, when not specified by the user, takes place as follows:
JobDefinition
,
TaskTypes
,
RecoveryOption
,
Serialized FormField Summary | |
---|---|
static java.lang.String |
COPYRIGHT
Copyright. |
Constructor Summary | |
---|---|
DistJobDefinition()
Creates an empty DistJobDefinition. |
|
DistJobDefinition(JobDefinitionHeader jobDefinitionHeader)
Creates a DistJobDefinition with the specified header. |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object object)
Returns true if all fields of this DistJobDefinition object are equal to those of the given one. |
Prompt |
getAbendPrompt()
Returns the job definition abend prompt. |
Identifier |
getAbendPromptId()
Returns the identifier of the job definition abend prompt. |
Identifier |
getRecoveryJobId()
Returns the identifier of the recovery job definition. |
JobDefinitionKey |
getRecoveryJobKey()
Returns the key of the recovery job definition. |
RecoveryOption |
getRecoveryOption()
Returns the job definition recovery option. |
java.lang.String |
getReturnCodeMapping()
Returns the job definition return code mapping. |
java.lang.String |
getTaskString()
Returns the job definition task string. |
int |
hashCode()
Returns a hash code for this DistJobDefinition object. |
boolean |
isInteractive()
Returns true if this job definition is interactive. |
void |
setAbendPrompt(Prompt prompt)
Sets the job definition abend prompt. |
void |
setAbendPromptId(Identifier identifier)
Sets the identifier of the job definition abend prompt. |
void |
setInteractive(boolean value)
Sets the property used to decide if this job definition is interactive. |
void |
setRecoveryJobId(Identifier identifier)
Sets the identifier of the recovery job definition. |
void |
setRecoveryJobKey(JobDefinitionKey recJobKey)
Sets the key of the recovery job definition. |
void |
setRecoveryOption(RecoveryOption value)
Sets the job definition recovery option. |
void |
setReturnCodeMapping(java.lang.String value)
Sets the job definition return code mapping. |
void |
setTaskString(java.lang.String value)
Sets the job definition task string. |
java.lang.String |
toString()
Returns a string representation of this DistJobDefinition object. |
Methods inherited from class com.ibm.tws.objects.model.JobDefinition |
---|
getDescription, getFlowTargetId, getFlowTargetKey, getHeader, getId, getKey, getLockData, getModifyData, getName, getNormalElapsedTime, getObjectHeader, getObjectKey, getTaskType, getUserLogin, isCommand, setCommand, setDescription, setFlowTargetId, setFlowTargetKey, setHeader, setId, setKey, setLockData, setModifyData, setName, setNormalElapsedTime, setTaskType, setUserLogin |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final java.lang.String COPYRIGHT
Constructor Detail |
public DistJobDefinition()
public DistJobDefinition(JobDefinitionHeader jobDefinitionHeader)
jobDefinitionHeader
- The job definition header.Method Detail |
public java.lang.String getTaskString()
public java.lang.String getReturnCodeMapping()
public boolean isInteractive()
public Identifier getRecoveryJobId()
public JobDefinitionKey getRecoveryJobKey()
public RecoveryOption getRecoveryOption()
public Identifier getAbendPromptId()
public Prompt getAbendPrompt()
public void setTaskString(java.lang.String value)
value
- The job definition task string.public void setReturnCodeMapping(java.lang.String value)
value
- The job definition return code mapping.public void setInteractive(boolean value)
value
- True if this job definition is interactive.public void setRecoveryJobId(Identifier identifier)
identifier
- The identifier of the recovery job definition.public void setRecoveryJobKey(JobDefinitionKey recJobKey)
recJobKey
- The key of the recovery job definition.public void setRecoveryOption(RecoveryOption value)
value
- The job definition recovery option.public void setAbendPromptId(Identifier identifier)
identifier
- The identifier of the job definition abend prompt.public void setAbendPrompt(Prompt prompt)
prompt
- The job definition abend prompt.public boolean equals(java.lang.Object object)
equals
in class JobDefinition
object
- The object to be compared with this one.
public int hashCode()
hashCode
in class JobDefinition
public java.lang.String toString()
toString
in class JobDefinition
|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |