com.ibm.tws.objects.model
Class JobDefinition

java.lang.Object
  extended bycom.ibm.tws.objects.model.JobDefinition
All Implemented Interfaces:
java.io.Serializable, TWSObject
Direct Known Subclasses:
DistJobDefinition, ZOSJobDefinition

public abstract class JobDefinition
extends java.lang.Object
implements TWSObject

This object, which acts as a base abstraction for job definitions, wraps a JobDefinitionHeader, which in turn wraps a JobDefinitionKey, including the reference to the workstation or workstation class on which the job definition can run. Separate classes are used to model specific attributes of job definitions in the TWS distributed and zOS environment.

See Also:
DistJobDefinition, ZOSJobDefinition, Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          Copyright.
 
Constructor Summary
JobDefinition()
          Creates an empty JobDefinition.
JobDefinition(JobDefinitionHeader jobDefinitionHeader)
          Creates a JobDefinition 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.
 java.lang.String getDescription()
          Returns the job definition description.
 Identifier getFlowTargetId()
          Returns the identifier of the workstation or workstation class referenced by this job definition.
 FlowTargetKey getFlowTargetKey()
          Returns the key of the workstation or workstation class referenced by this job definition.
 JobDefinitionHeader getHeader()
          Returns the JobDefinitionHeader wrapped by this JobDefinition object.
 Identifier getId()
          Returns the job definition identifier.
 JobDefinitionKey getKey()
          Returns the JobDefinitionKey wrapped by this JobDefinition object.
 LockData getLockData()
          Returns the job definition lock data.
 ModifyData getModifyData()
          Returns the job definition modification data.
 java.lang.String getName()
          Returns the job definition name.
 long getNormalElapsedTime()
          Returns the normal elapsed time of a job run.
 TWSHeader getObjectHeader()
          Returns the job definition header as a TWS header.
 TWSKey getObjectKey()
          Returns the job definition key as a TWS key.
 java.lang.String getTaskType()
          Returns the job definition task type.
 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 isCommand()
          Returns true if the task is a command, false if it is a script.
 void setCommand(boolean value)
          Sets the property used to decide if the task is a command or a script.
 void setDescription(java.lang.String value)
          Sets the job definition description.
 void setFlowTargetId(Identifier identifier)
          Sets the identifier of the workstation or workstation class referenced by this job definition.
 void setFlowTargetKey(FlowTargetKey trgKey)
          Sets the key of the workstation or workstation class referenced by this job definition.
 void setHeader(JobDefinitionHeader jobDefinitionHeader)
          Sets the JobDefinitionHeader to be wrapped by this JobDefinition object.
 void setId(Identifier identifier)
          Sets the job definition identifier.
 void setKey(JobDefinitionKey jobDefinitionKey)
          Sets the JobDefinitionKey to be wrapped by this JobDefinition object.
 void setLockData(LockData data)
          Sets the job definition lock data.
 void setModifyData(ModifyData data)
          Sets the job definition modification data.
 void setName(java.lang.String value)
          Sets the job definition name.
 void setNormalElapsedTime(long value)
          Sets the normal elapsed time of a job run.
 void setTaskType(java.lang.String value)
          Sets the job definition task type.
 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 object.
 
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

JobDefinition

public JobDefinition()
Creates an empty JobDefinition.


JobDefinition

public JobDefinition(JobDefinitionHeader jobDefinitionHeader)
Creates a JobDefinition 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 job definition key as a TWS key.

Specified by:
getObjectKey in interface TWSObject
Returns:
The job definition key as a TWS key.

getObjectHeader

public TWSHeader getObjectHeader()
Returns the job definition header as a TWS header.

Specified by:
getObjectHeader in interface TWSObject
Returns:
The job definition header as a TWS header.

getKey

public JobDefinitionKey getKey()
Returns the JobDefinitionKey wrapped by this JobDefinition object.

Returns:
The JobDefinitionKey wrapped by this JobDefinition object.

getHeader

public JobDefinitionHeader getHeader()
Returns the JobDefinitionHeader wrapped by this JobDefinition object.

Returns:
The JobDefinitionHeader wrapped by this JobDefinition object.

getName

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

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

getFlowTargetKey

public FlowTargetKey getFlowTargetKey()
Returns the key of the workstation or workstation class referenced by this job definition.

Returns:
The key of the workstation or workstation class 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.

Returns:
The job definition task type.

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.

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.

getModifyData

public ModifyData getModifyData()
Returns the job definition modification data.

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

getLockData

public LockData getLockData()
Returns the job definition lock data.

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

getFlowTargetId

public Identifier getFlowTargetId()
Returns the identifier of the workstation or workstation class referenced by this job definition.

Returns:
The identifier of the workstation or workstation class referenced by this job definition.

getNormalElapsedTime

public long getNormalElapsedTime()
Returns the normal elapsed time of a job run.

Returns:
The normal elapsed time of a job run.

setId

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

Parameters:
identifier - The job definition identifier.

setKey

public void setKey(JobDefinitionKey jobDefinitionKey)
Sets the JobDefinitionKey to be wrapped by this JobDefinition object.

Parameters:
jobDefinitionKey - The JobDefinitionKey to be wrapped by this JobDefinition object.

setHeader

public void setHeader(JobDefinitionHeader jobDefinitionHeader)
Sets the JobDefinitionHeader to be wrapped by this JobDefinition object.

Parameters:
jobDefinitionHeader - The JobDefinitionHeader to be wrapped by this JobDefinition object.

setName

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

Parameters:
value - The job definition name.

setFlowTargetKey

public void setFlowTargetKey(FlowTargetKey trgKey)
Sets the key of the workstation or workstation class referenced by this job definition.

Parameters:
trgKey - The key of the workstation or workstation class 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.

Parameters:
value - The job definition task type.

setCommand

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

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

setUserLogin

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

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

setModifyData

public void setModifyData(ModifyData data)
Sets the job definition modification data. For internal use only.

Parameters:
data - A ModifyData object.

setLockData

public void setLockData(LockData data)
Sets the job definition lock data. For internal use only.

Parameters:
data - A LockData object.

setFlowTargetId

public void setFlowTargetId(Identifier identifier)
Sets the identifier of the workstation or workstation class referenced by this job definition.

Parameters:
identifier - The identifier of the workstation or workstation class referenced by this job definition.

setNormalElapsedTime

public void setNormalElapsedTime(long value)
Sets the normal elapsed time of a job run. For internal use only.

Parameters:
value - The normal elapsed time of a job run.

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.

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.

Returns:
The object's hash code.

toString

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

Returns:
A text string including all JobDefinition fields.


Copyright © 2005 IBM All Rights Reserved.