com.ibm.tws.objects.plan
Class DistJobDefinitionInPlan

java.lang.Object
  extended bycom.ibm.tws.objects.plan.JobDefinitionInPlan
      extended bycom.ibm.tws.objects.plan.DistJobDefinitionInPlan
All Implemented Interfaces:
java.io.Serializable, TWSObject

public class DistJobDefinitionInPlan
extends JobDefinitionInPlan

This class, representing a job definition object, references the key of the associated recovery job definition, and a PromptInPlan object, to define the recovery prompt (if any). It wraps a JobDefinitionInPlanHeader, which in turn wraps a JobDefinitionInPlanKey, including the reference to the key of the WorkstationInPlan on which the job instance can run. All the attributes of this class are output only, unless the Job Definition is part of the output of a makeJobInPlan API or of a makeJobStream API.

The following syntax validation constraints must be met on DistJobDefinitionInPlan objects:

name Name of an Existing Job Definition.
workstationKey Reference to an existing workstation
description N/A
taskType One of the values in TaskTypes
or any other value.
command Default value is false.
userLogin Always required
Not longer than 47 characters
It can contain parameters.
recoveryJobKey If specified, must reference an existing job definition
taskString Always required
Its length plus the returnCode mapping length must be
Not longer than 4095 characters.
It can contain parameters.
returnCodeMapping Its length plus the returnCode mapping length must be
Not longer than 4095 characters
isInteractive Default value is false
Ignored if taskType is other than WINDOWSTASK
recoveryOption One of the values exposed by the RecoveryOption class
Default value is STOP.
abendPromptText If specified, the text must not be longer than 64 characters
It can contain parameters.
returnCode Default value is 0
recoveryJob A pointer to the recovery JobInPlan of this job.

See Also:
JobInPlan, JobDefinitionInPlan, PromptInPlan, WorkstationInPlanKey, Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          Copyright.
 
Constructor Summary
DistJobDefinitionInPlan()
          Creates an empty DistJobDefinitionInPlan.
DistJobDefinitionInPlan(JobDefinitionInPlanHeader jobDefinitionHeader)
          Creates a DistJobDefinitionInPlan with the specified header.
 
Method Summary
 boolean equals(java.lang.Object object)
          Returns true if all fields of this JobDefinition object are equal to those of the given one.
 RecoveryOption getRecoveryOption()
          Returns the job definition recovery option.
 int getReturnCode()
          Returns the return code for this job definition.
 java.lang.String getReturnCodeMapping()
          Returns the job definition return code mapping.
 java.lang.String getTaskString()
          Returns the job definition task string.
 java.lang.String getUserLogin()
          Returns the user login to be used for this job definition.
 int hashCode()
          Returns a hash code for this JobDefinition object.
 boolean isInteractive()
          Returns true if this job definition is interactive.
 void setInteractive(boolean value)
          Sets the property used to state if this job definition is interactive.
 void setRecoveryOption(RecoveryOption value)
          Sets the job definition recovery option.
 void setReturnCode(int value)
          Sets the return code for this job definition.
 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.
 void setUserLogin(java.lang.String value)
          Sets the user login to be used for this job definition.
 java.lang.String toString()
          Returns a string representation of this JobDefinition.
 
Methods inherited from class com.ibm.tws.objects.plan.JobDefinitionInPlan
getAbendPromptId, getAbendPromptKey, getAbendPromptText, getDescription, getHeader, getId, getKey, getLockData, getModifyData, getName, getObjectHeader, getObjectKey, getRecoveryJob, getRecoveryJobId, getRecoveryJobKey, getTaskType, getWorkstationId, getWorkstationKey, isCommand, setAbendPromptId, setAbendPromptKey, setAbendPromptText, setCommand, setDescription, setHeader, setId, setKey, setName, setRecoveryJob, setRecoveryJobId, setRecoveryJobKey, setTaskType, setWorkstationId, setWorkstationKey
 
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

DistJobDefinitionInPlan

public DistJobDefinitionInPlan()
Creates an empty DistJobDefinitionInPlan.


DistJobDefinitionInPlan

public DistJobDefinitionInPlan(JobDefinitionInPlanHeader jobDefinitionHeader)
Creates a DistJobDefinitionInPlan with the specified header.

Parameters:
jobDefinitionHeader - The job definition header.
Method Detail

getTaskString

public java.lang.String getTaskString()
Returns the job definition task string.

Returns:
The job definition task string.

getReturnCodeMapping

public java.lang.String getReturnCodeMapping()
Returns the job definition return code mapping.

Returns:
The job definition return code mapping.

isInteractive

public boolean isInteractive()
Returns true if this job definition is interactive.

Returns:
True if this job definition is interactive.

getRecoveryOption

public RecoveryOption getRecoveryOption()
Returns the job definition recovery option.

Returns:
The job definition recovery option.

getUserLogin

public java.lang.String getUserLogin()
Returns the user login to be used for this job definition.

Returns:
The user login to be used for this job definition.

getReturnCode

public int getReturnCode()
Returns the return code for this job definition.

Returns:
The return code for this job definition.

setTaskString

public void setTaskString(java.lang.String value)
Sets the job definition task string. For internal use only.

Parameters:
value - The job definition task string.

setReturnCodeMapping

public void setReturnCodeMapping(java.lang.String value)
Sets the job definition return code mapping. For internal use only.

Parameters:
value - The job definition return code mapping.

setInteractive

public void setInteractive(boolean value)
Sets the property used to state if this job definition is interactive. For internal use only.

Parameters:
value - True if this job definition is interactive.

setRecoveryOption

public void setRecoveryOption(RecoveryOption value)
Sets the job definition recovery option. For internal use only.

Parameters:
value - The job definition recovery option.

setUserLogin

public void setUserLogin(java.lang.String value)
Sets the user login to be used for this job definition. For internal use only.

Parameters:
value - The user login to be used for this job definition.

setReturnCode

public void setReturnCode(int value)
Sets the return code for this job definition. For internal use only.

Parameters:
value - The return code for this job definition.

equals

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

Overrides:
equals in class JobDefinitionInPlan
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 JobDefinition object.

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

toString

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

Overrides:
toString in class JobDefinitionInPlan
Returns:
A text string including all JobDefinition fields.


Copyright © 2005 IBM All Rights Reserved.