|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.tws.objects.plan.JobDefinitionInPlan
This object, which acts as a base abstraction for job definitions, wraps a JobDefinitionInPlanHeader, which in turn wraps a JobDefinitionInPlanKey, including the reference to the workstation on which the job definition is defined. Separate classes are used to model specific attributes of job definitions in the TWS distributed and zOS environment. Thsi class also contains references to the recovery job definition and to the recovery prompt.
DistJobDefinitionInPlan
,
ZOSJobDefinitionInPlan
,
Serialized FormField Summary | |
---|---|
static java.lang.String |
COPYRIGHT
Copyright. |
Constructor Summary | |
---|---|
JobDefinitionInPlan()
Creates an empty JobDefinitionInPlan. |
|
JobDefinitionInPlan(JobDefinitionInPlanHeader jobDefinitionHeader)
Creates a JobDefinitionInPlan with the specified header. |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object object)
Returns true if all fields of this JobDefinitionInPlan object are equal to those of the given one. |
Identifier |
getAbendPromptId()
Returns the Identifier of the job definition abend prompt. |
PromptInPlanKey |
getAbendPromptKey()
Returns the job definition abend prompt key. |
java.lang.String |
getAbendPromptText()
Returns the recovery abend prompt text. |
java.lang.String |
getDescription()
Returns the job definition description. |
JobDefinitionInPlanHeader |
getHeader()
Returns the JobDefinitionInPlanHeader wrapped by this JobDefinitionInPlan object. |
Identifier |
getId()
Returns the job definition identifier. |
JobDefinitionInPlanKey |
getKey()
Returns the JobDefinitionInPlanKey wrapped by this JobDefinitionInPlan object. |
LockData |
getLockData()
Returns the object lock data. |
ModifyData |
getModifyData()
Returns the object modification data. |
java.lang.String |
getName()
Returns the job definition name. |
TWSHeader |
getObjectHeader()
Returns the object header. |
TWSKey |
getObjectKey()
Returns the object key. |
JobInPlan |
getRecoveryJob()
Returns the Recovery job referenced by this job definition For internal use only. |
Identifier |
getRecoveryJobId()
Returns the Identifier of the recovery job definition. |
JobDefinitionInPlanKey |
getRecoveryJobKey()
Returns the key of the recovery job definition. |
java.lang.String |
getTaskType()
Returns the job definition task type. |
Identifier |
getWorkstationId()
Returns the Identifier of the referenced Workstation. |
WorkstationInPlanKey |
getWorkstationKey()
Returns the key of the workstation referenced by this job definition. |
int |
hashCode()
Returns a hash code for this JobDefinitionInPlan object. |
boolean |
isCommand()
Returns true if the task is a command, false if it is a script. |
void |
setAbendPromptId(Identifier identifier)
Sets the identifier of the job definition abend prompt. |
void |
setAbendPromptKey(PromptInPlanKey prompt)
Sets the job definition abend prompt key. |
void |
setAbendPromptText(java.lang.String string)
Sets the Recovery abend prompt Text |
void |
setCommand(boolean value)
Sets the property used to state if the task is a command or a script. |
void |
setDescription(java.lang.String value)
Sets the job definition description. |
void |
setHeader(JobDefinitionInPlanHeader jobDefinitionHeader)
Sets the JobDefinitionInPlanHeader to be wrapped by this JobDefinitionInPlan object. |
void |
setId(Identifier identifier)
Sets the job definition identifier. |
void |
setKey(JobDefinitionInPlanKey jobDefinitionKey)
Sets the JobDefinitionInPlanKey to be wrapped by this JobDefinitionInPlan object. |
void |
setName(java.lang.String value)
Sets the job definition name. |
void |
setRecoveryJob(JobInPlan plan)
Sets the Recovery job referenced by this job definition For internal use only. |
void |
setRecoveryJobId(Identifier identifier)
Sets the identifier of the recovery job definition. |
void |
setRecoveryJobKey(JobDefinitionInPlanKey key)
Sets the key of the recovery job definition. |
void |
setTaskType(java.lang.String value)
Sets the job definition task type. |
void |
setWorkstationId(Identifier identifier)
Sets the Identifier of the referenced Workstation. |
void |
setWorkstationKey(WorkstationInPlanKey wksKey)
Sets the key of the workstation referenced by this job definition. |
java.lang.String |
toString()
Returns a string representation of this JobDefinitionInPlan. |
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 JobDefinitionInPlan()
public JobDefinitionInPlan(JobDefinitionInPlanHeader jobDefinitionHeader)
jobDefinitionHeader
- The job definition header.Method Detail |
public Identifier getId()
getId
in interface TWSObject
public TWSKey getObjectKey()
getObjectKey
in interface TWSObject
TWSObject.getObjectKey()
public TWSHeader getObjectHeader()
getObjectHeader
in interface TWSObject
TWSObject.getObjectHeader()
public JobDefinitionInPlanKey getKey()
public JobDefinitionInPlanHeader getHeader()
public java.lang.String getName()
getName
in interface TWSObject
public WorkstationInPlanKey getWorkstationKey()
public java.lang.String getDescription()
public java.lang.String getTaskType()
om.ibm.tws.objects.types.TaskTypes
public JobDefinitionInPlanKey getRecoveryJobKey()
public ModifyData getModifyData()
getModifyData
in interface TWSObject
public LockData getLockData()
getLockData
in interface TWSObject
public Identifier getRecoveryJobId()
public void setId(Identifier identifier)
identifier
- The job definition identifier.public void setKey(JobDefinitionInPlanKey jobDefinitionKey)
jobDefinitionKey
- The JobDefinitionInPlanKey to be wrapped by this JobDefinitionInPlan object.public void setHeader(JobDefinitionInPlanHeader jobDefinitionHeader)
jobDefinitionHeader
- The JobDefinitionInPlanHeader to be wrapped by this JobDefinitionInPlan object.public void setName(java.lang.String value)
value
- The job definition name.public void setWorkstationKey(WorkstationInPlanKey wksKey)
wksKey
- The key of the workstation referenced by this job definition.public void setDescription(java.lang.String value)
value
- The job definition description.public void setTaskType(java.lang.String value)
value
- The job definition task type.om.ibm.tws.objects.types.TaskTypes
public void setRecoveryJobKey(JobDefinitionInPlanKey key)
key
- The key of the recovery job definition.public void setRecoveryJobId(Identifier identifier)
identifier
- The identifier of the recovery job definition.public boolean equals(java.lang.Object object)
object
- The object to be compared with this one.
public int hashCode()
public java.lang.String toString()
public Identifier getWorkstationId()
public void setWorkstationId(Identifier identifier)
identifier
- the Workstation Identifier to set.public boolean isCommand()
public void setCommand(boolean value)
value
- True if the task is a command, false if it is a script.public Identifier getAbendPromptId()
public PromptInPlanKey getAbendPromptKey()
public void setAbendPromptId(Identifier identifier)
identifier
- The identifier of the job definition abend prompt.public void setAbendPromptKey(PromptInPlanKey prompt)
prompt
- The job definition abend prompt key.public JobInPlan getRecoveryJob()
public void setRecoveryJob(JobInPlan plan)
plan
- the recovery job.public java.lang.String getAbendPromptText()
public void setAbendPromptText(java.lang.String string)
string
- the Recovery abend prompt Text to set.
|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |