com.ibm.tws.objects.plan
Class JobDefinitionInPlanHeader

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

public class JobDefinitionInPlanHeader
extends java.lang.Object
implements TWSHeader

This class is an utility class to host attributes of a Job Definition in plan. It implements the interface TWSHeader.

See Also:
JobDefinitionInPlan, Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          Copyright.
 
Constructor Summary
JobDefinitionInPlanHeader()
          Creates an empty JobDefinitionInPlanHeader.
JobDefinitionInPlanHeader(Identifier jobDefinitionId)
          Creates a JobDefinitionInPlanHeader with the specified Identifier.
JobDefinitionInPlanHeader(Identifier jobDefinitionId, JobDefinitionInPlanKey jobDefinitionKey)
          Creates a JobDefinitionInPlanHeader with the specified identifier and key.
JobDefinitionInPlanHeader(JobDefinitionInPlanKey jobDefinitionKey)
          Creates a JobDefinitionInPlanHeader with the specified key.
 
Method Summary
 boolean equals(java.lang.Object object)
          Returns true if all fields of this JobDefinitionInPlanHeader object are equal to those of the given one.
 java.lang.String getDescription()
          Returns the job definition description.
 Identifier getId()
          Returns the job definition Identifier.
 JobDefinitionInPlanKey getKey()
          Returns the JobDefinitionInPlanKey wrapped by this JobDefinitionInPlanHeader object.
 LockData getLockData()
          Returns the object lock data.
 ModifyData getModifyData()
          Returns the object modification data.
 java.lang.String getName()
          Returns the job definition name.
 TWSKey getObjectKey()
          Returns the object key.
 JobDefinitionInPlanKey getRecoveryJobKey()
          Returns the key of the recovery job definition.
 java.lang.String getTaskType()
          Returns the job definition task type.
 WorkstationInPlanKey getWorkstationKey()
          Returns the key of the workstation referenced by this job definition.
 int hashCode()
          Returns a hash code for this JobDefinitionInPlanHeader object.
 boolean isCommand()
          Returns true if this job definitions refers to a command, false if refers to a script
 void setCommand(boolean b)
          Sets if this job definitions refers to a command or if refers to a script
 void setDescription(java.lang.String value)
          Sets the job definition description.
 void setId(Identifier identifier)
          Sets the job definition Identifier.
 void setKey(JobDefinitionInPlanKey jobDefinitionKey)
          Sets the JobDefinitionKey to be wrapped by this JobDefinitionInPlanHeader object.
 void setName(java.lang.String value)
          Sets the job definition name.
 void setRecoveryJobKey(JobDefinitionInPlanKey recJobKey)
          Sets the key of the recovery job definition.
 void setTaskType(java.lang.String value)
          Sets the job definition task type.
 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 JobDefinitionInPlanHeader.
 
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

JobDefinitionInPlanHeader

public JobDefinitionInPlanHeader()
Creates an empty JobDefinitionInPlanHeader.


JobDefinitionInPlanHeader

public JobDefinitionInPlanHeader(Identifier jobDefinitionId)
Creates a JobDefinitionInPlanHeader with the specified Identifier.

Parameters:
jobDefinitionId - The job definition Identifier.

JobDefinitionInPlanHeader

public JobDefinitionInPlanHeader(JobDefinitionInPlanKey jobDefinitionKey)
Creates a JobDefinitionInPlanHeader with the specified key.

Parameters:
jobDefinitionKey - The job definition key.

JobDefinitionInPlanHeader

public JobDefinitionInPlanHeader(Identifier jobDefinitionId,
                                 JobDefinitionInPlanKey jobDefinitionKey)
Creates a JobDefinitionInPlanHeader 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 object key.

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

getKey

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

Returns:
The JobDefinitionInPlanKey wrapped by this JobDefinitionInPlanHeader object.

getName

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

Specified by:
getName in interface TWSHeader
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 of 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 objects it returns always null

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

getLockData

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

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

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 JobDefinitionKey to be wrapped by this JobDefinitionInPlanHeader object.

Parameters:
jobDefinitionKey - The JobDefinitionKey to be wrapped by this JobDefinitionInPlanHeader 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. For internal use only.

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.

setRecoveryJobKey

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

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

equals

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

Returns:
The object's hash code.

toString

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

Returns:
A text string including all JobDefinitionInPlanHeader fields.

isCommand

public boolean isCommand()
Returns true if this job definitions refers to a command, false if refers to a script

Returns:
true if this job definitions refers to a command, false if refers to a script

setCommand

public void setCommand(boolean b)
Sets if this job definitions refers to a command or if refers to a script

Parameters:
b - true if this job definitions refers to a command, false if refers to a script


Copyright © 2005 IBM All Rights Reserved.