com.ibm.tws.objects.model
Class JobDefinitionHeader

java.lang.Object
  extended bycom.ibm.tws.objects.model.JobDefinitionHeader
All Implemented Interfaces:
java.io.Serializable, TWSHeader

public class JobDefinitionHeader
extends java.lang.Object
implements TWSHeader

This class hosts the attributes to be shown in TWS external interfaces when listing job definitions.

See Also:
JobDefinition, Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          Copyright.
 
Constructor Summary
JobDefinitionHeader()
          Creates an empty JobDefinitionHeader.
JobDefinitionHeader(Identifier jobDefinitionId)
          Creates a JobDefinitionHeader with the specified identifier.
JobDefinitionHeader(Identifier jobDefinitionId, JobDefinitionKey jobDefinitionKey)
          Creates a JobDefinitionHeader with the specified identifier and key.
JobDefinitionHeader(JobDefinitionKey jobDefinitionKey)
          Creates a JobDefinitionHeader with the specified key.
 
Method Summary
 boolean equals(java.lang.Object object)
          Returns true if all fields of this JobDefinitionHeader object are equal to those of the given one.
 java.lang.String getDescription()
          Returns the job definition description.
 FlowTargetKey getFlowTargetKey()
          Returns the key of the workstation or workstation class referenced by this job definition.
 Identifier getId()
          Returns the job definition identifier.
 JobDefinitionKey getKey()
          Returns the JobDefinitionKey wrapped by this JobDefinitionHeader 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.
 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 JobDefinitionHeader 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 setFlowTargetKey(FlowTargetKey trgKey)
          Sets the key of the workstation or workstation class referenced by this job definition.
 void setId(Identifier identifier)
          Sets the job definition identifier.
 void setKey(JobDefinitionKey jobDefinitionKey)
          Sets the JobDefinitionKey to be wrapped by this JobDefinitionHeader 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 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 JobDefinitionHeader 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

JobDefinitionHeader

public JobDefinitionHeader()
Creates an empty JobDefinitionHeader.


JobDefinitionHeader

public JobDefinitionHeader(Identifier jobDefinitionId)
Creates a JobDefinitionHeader with the specified identifier.

Parameters:
jobDefinitionId - The job definition identifier.

JobDefinitionHeader

public JobDefinitionHeader(JobDefinitionKey jobDefinitionKey)
Creates a JobDefinitionHeader with the specified key.

Parameters:
jobDefinitionKey - The job definition key.

JobDefinitionHeader

public JobDefinitionHeader(Identifier jobDefinitionId,
                           JobDefinitionKey jobDefinitionKey)
Creates a JobDefinitionHeader with the specified identifier and key.

Parameters:
jobDefinitionId - The job definition identifier.
jobDefinitionKey - The job definition key.
Method Detail

getId

public Identifier getId()
Returns the job definition identifier.

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

getObjectKey

public TWSKey getObjectKey()
Returns the job definition key as a TWS key.

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

getKey

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

Returns:
The JobDefinitionKey wrapped by this JobDefinitionHeader object.

getName

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

Specified by:
getName in interface TWSHeader
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 TWSHeader
Returns:
The job definition modification data.

getLockData

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

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

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

Parameters:
jobDefinitionKey - The JobDefinitionKey to be wrapped by this JobDefinitionHeader 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.

equals

public boolean equals(java.lang.Object object)
Returns true if all fields of this JobDefinitionHeader 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 JobDefinitionHeader object.

Returns:
The object's hash code.

toString

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

Returns:
A text string including all JobDefinitionHeader fields.


Copyright © 2005 IBM All Rights Reserved.