com.ibm.tws.objects.plan
Class JobDefinitionInPlan

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

public class JobDefinitionInPlan
extends java.lang.Object
implements TWSObject

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.

See Also:
DistJobDefinitionInPlan, ZOSJobDefinitionInPlan, Serialized Form

Field 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

COPYRIGHT

public static final java.lang.String COPYRIGHT
Copyright.

Constructor Detail

JobDefinitionInPlan

public JobDefinitionInPlan()
Creates an empty JobDefinitionInPlan.


JobDefinitionInPlan

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

Parameters:
jobDefinitionHeader - The job definition header.
Method Detail

getId

public Identifier getId()
Returns the job definition identifier.

Specified by:
getId in interface TWSObject
Returns:
The job definition identifier.

getObjectKey

public TWSKey getObjectKey()
Returns the object key.

Specified by:
getObjectKey in interface TWSObject
Returns:
The object key.
See Also:
TWSObject.getObjectKey()

getObjectHeader

public TWSHeader getObjectHeader()
Returns the object header.

Specified by:
getObjectHeader in interface TWSObject
Returns:
The object header.
See Also:
TWSObject.getObjectHeader()

getKey

public JobDefinitionInPlanKey getKey()
Returns the JobDefinitionInPlanKey wrapped by this JobDefinitionInPlan object.

Returns:
The JobDefinitionInPlanKey wrapped by this JobDefinitionInPlan object.

getHeader

public JobDefinitionInPlanHeader getHeader()
Returns the JobDefinitionInPlanHeader wrapped by this JobDefinitionInPlan object.

Returns:
The JobDefinitionInPlanHeader wrapped by this JobDefinitionInPlan object.

getName

public java.lang.String getName()
Returns the job definition name.

Specified by:
getName in interface TWSObject
Returns:
The job definition name.

getWorkstationKey

public WorkstationInPlanKey getWorkstationKey()
Returns the key of the workstation referenced by this job definition.

Returns:
The key of the workstation referenced by this job definition.

getDescription

public java.lang.String getDescription()
Returns the job definition description.

Returns:
The job definition description.

getTaskType

public java.lang.String getTaskType()
Returns the job definition task type. It could be one of the values exposed by the interface TaskTypes.

Returns:
The job definition task type.
See Also:
om.ibm.tws.objects.types.TaskTypes

getRecoveryJobKey

public JobDefinitionInPlanKey getRecoveryJobKey()
Returns the key of the recovery job definition.

Returns:
The key of the recovery job definition.

getModifyData

public ModifyData getModifyData()
Returns the object modification data. For plan object, it returns always null.

Specified by:
getModifyData in interface TWSObject
Returns:
The object modification data.

getLockData

public LockData getLockData()
Returns the object lock data. For plan object, it returns always null.

Specified by:
getLockData in interface TWSObject
Returns:
The object lock data.

getRecoveryJobId

public Identifier getRecoveryJobId()
Returns the Identifier of the recovery job definition.

Returns:
The Identifier of the recovery job definition.

setId

public void setId(Identifier identifier)
Sets the job definition identifier.

Parameters:
identifier - The job definition identifier.

setKey

public void setKey(JobDefinitionInPlanKey jobDefinitionKey)
Sets the JobDefinitionInPlanKey to be wrapped by this JobDefinitionInPlan object.

Parameters:
jobDefinitionKey - The JobDefinitionInPlanKey to be wrapped by this JobDefinitionInPlan object.

setHeader

public void setHeader(JobDefinitionInPlanHeader jobDefinitionHeader)
Sets the JobDefinitionInPlanHeader to be wrapped by this JobDefinitionInPlan object.

Parameters:
jobDefinitionHeader - The JobDefinitionInPlanHeader to be wrapped by this JobDefinitionInPlan object.

setName

public void setName(java.lang.String value)
Sets the job definition name.

Parameters:
value - The job definition name.

setWorkstationKey

public void setWorkstationKey(WorkstationInPlanKey wksKey)
Sets the key of the workstation referenced by this job definition.

Parameters:
wksKey - The key of the workstation referenced by this job definition.

setDescription

public void setDescription(java.lang.String value)
Sets the job definition description.

Parameters:
value - The job definition description.

setTaskType

public void setTaskType(java.lang.String value)
Sets the job definition task type. It could be one of the values exposed by the interfaces TaskTypes

Parameters:
value - The job definition task type.
See Also:
om.ibm.tws.objects.types.TaskTypes

setRecoveryJobKey

public void setRecoveryJobKey(JobDefinitionInPlanKey key)
Sets the key of the recovery job definition.

Parameters:
key - The key of the recovery job definition.

setRecoveryJobId

public void setRecoveryJobId(Identifier identifier)
Sets the identifier of the recovery job definition.

Parameters:
identifier - The identifier of the recovery job definition.

equals

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

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 JobDefinitionInPlan object.

Returns:
The object's hash code.

toString

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

Returns:
A text string including all JobDefinitionInPlan fields.

getWorkstationId

public Identifier getWorkstationId()
Returns the Identifier of the referenced Workstation.

Returns:
the Workstation Identifier

setWorkstationId

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

Parameters:
identifier - the Workstation Identifier to set.

isCommand

public boolean isCommand()
Returns true if the task is a command, false if it is a script.

Returns:
True if the task is a command, false if it is a script.

setCommand

public void setCommand(boolean value)
Sets the property used to state if the task is a command or a script.

Parameters:
value - True if the task is a command, false if it is a script.

getAbendPromptId

public Identifier getAbendPromptId()
Returns the Identifier of the job definition abend prompt. For Internal Use Only.

Returns:
the Identifier of the job definition abend prompt.

getAbendPromptKey

public PromptInPlanKey getAbendPromptKey()
Returns the job definition abend prompt key. For internal Use only.

Returns:
the job definition abend prompt key.

setAbendPromptId

public void setAbendPromptId(Identifier identifier)
Sets the identifier of the job definition abend prompt. For internal use only.

Parameters:
identifier - The identifier of the job definition abend prompt.

setAbendPromptKey

public void setAbendPromptKey(PromptInPlanKey prompt)
Sets the job definition abend prompt key. For internal use only.

Parameters:
prompt - The job definition abend prompt key.

getRecoveryJob

public JobInPlan getRecoveryJob()
Returns the Recovery job referenced by this job definition For internal use only.

Returns:
the recovery job.

setRecoveryJob

public void setRecoveryJob(JobInPlan plan)
Sets the Recovery job referenced by this job definition For internal use only.

Parameters:
plan - the recovery job.

getAbendPromptText

public java.lang.String getAbendPromptText()
Returns the recovery abend prompt text.

Returns:
the recovery abend prompt text.

setAbendPromptText

public void setAbendPromptText(java.lang.String string)
Sets the Recovery abend prompt Text

Parameters:
string - the Recovery abend prompt Text to set.


Copyright © 2005 IBM All Rights Reserved.