com.ibm.tws.objects.model
Class DistJobDefinition

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

public class DistJobDefinition
extends JobDefinition

This object, representing a job definition in the TWS distributed environment, references a recovery job definition and a Prompt object, to optionally define a recovery message (also called "abend prompt").

The following syntax validation constraints must be met on DistJobDefinition objects:

name Always required
Alphanumeric characters
Starting with alphabetic character
'-' and '_' characters allowed
Blank spaces not allowed
Not longer than 40 characters
flowTargetKey Must reference an existing workstation or class
description Not longer than 120 characters
taskType Not longer than 50 characters
Default value is calculated as described below
command Default value is false
userLogin Always required
Not longer than 47 characters
recoveryJobKey If specified, must reference an existing job definition
taskString Always required
Not longer than 4095 characters
returnCodeMapping A boolean expression including comparison operators
Not longer than 256 characters
interactive Default value is false
Ignored if taskType is other than WINDOWSTASK
recoveryOption One of the values exposed by the RecoveryOption class
Always required
Default value is STOP
abendPrompt If specified, the text must not be longer than 64 characters

The assignment of a value to the taskType field, when not specified by the user, takes place as follows:

  • The workstation associated to the job definition is loaded from the database
  • If the workstation is an SA, FTA or a domain manager, taskType is set to WINDOWSTASK or UNIXTASK, depending on the operating system of the workstation
  • If the workstation is an XA, the access method is used to access the database and get the associated task type; if the task type is not found in the database, taskType is set to XATASK
  • After installation, the only access method in the database is r3batch
  • No check is done on the taskType field (except for the maximum length) if a value is specified by the user
  • See Also:
    JobDefinition, TaskTypes, RecoveryOption, Serialized Form

    Field Summary
    static java.lang.String COPYRIGHT
              Copyright.
     
    Constructor Summary
    DistJobDefinition()
              Creates an empty DistJobDefinition.
    DistJobDefinition(JobDefinitionHeader jobDefinitionHeader)
              Creates a DistJobDefinition with the specified header.
     
    Method Summary
     boolean equals(java.lang.Object object)
              Returns true if all fields of this DistJobDefinition object are equal to those of the given one.
     Prompt getAbendPrompt()
              Returns the job definition abend prompt.
     Identifier getAbendPromptId()
              Returns the identifier of the job definition abend prompt.
     Identifier getRecoveryJobId()
              Returns the identifier of the recovery job definition.
     JobDefinitionKey getRecoveryJobKey()
              Returns the key of the recovery job definition.
     RecoveryOption getRecoveryOption()
              Returns the job definition recovery option.
     java.lang.String getReturnCodeMapping()
              Returns the job definition return code mapping.
     java.lang.String getTaskString()
              Returns the job definition task string.
     int hashCode()
              Returns a hash code for this DistJobDefinition object.
     boolean isInteractive()
              Returns true if this job definition is interactive.
     void setAbendPrompt(Prompt prompt)
              Sets the job definition abend prompt.
     void setAbendPromptId(Identifier identifier)
              Sets the identifier of the job definition abend prompt.
     void setInteractive(boolean value)
              Sets the property used to decide if this job definition is interactive.
     void setRecoveryJobId(Identifier identifier)
              Sets the identifier of the recovery job definition.
     void setRecoveryJobKey(JobDefinitionKey recJobKey)
              Sets the key of the recovery job definition.
     void setRecoveryOption(RecoveryOption value)
              Sets the job definition recovery option.
     void setReturnCodeMapping(java.lang.String value)
              Sets the job definition return code mapping.
     void setTaskString(java.lang.String value)
              Sets the job definition task string.
     java.lang.String toString()
              Returns a string representation of this DistJobDefinition object.
     
    Methods inherited from class com.ibm.tws.objects.model.JobDefinition
    getDescription, getFlowTargetId, getFlowTargetKey, getHeader, getId, getKey, getLockData, getModifyData, getName, getNormalElapsedTime, getObjectHeader, getObjectKey, getTaskType, getUserLogin, isCommand, setCommand, setDescription, setFlowTargetId, setFlowTargetKey, setHeader, setId, setKey, setLockData, setModifyData, setName, setNormalElapsedTime, setTaskType, setUserLogin
     
    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

    DistJobDefinition

    public DistJobDefinition()
    Creates an empty DistJobDefinition.


    DistJobDefinition

    public DistJobDefinition(JobDefinitionHeader jobDefinitionHeader)
    Creates a DistJobDefinition with the specified header.

    Parameters:
    jobDefinitionHeader - The job definition header.
    Method Detail

    getTaskString

    public java.lang.String getTaskString()
    Returns the job definition task string.

    Returns:
    The job definition task string.

    getReturnCodeMapping

    public java.lang.String getReturnCodeMapping()
    Returns the job definition return code mapping.

    Returns:
    The job definition return code mapping.

    isInteractive

    public boolean isInteractive()
    Returns true if this job definition is interactive.

    Returns:
    True if this job definition is interactive.

    getRecoveryJobId

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

    Returns:
    The identifier of the recovery job definition.

    getRecoveryJobKey

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

    Returns:
    The key of the recovery job definition.

    getRecoveryOption

    public RecoveryOption getRecoveryOption()
    Returns the job definition recovery option.

    Returns:
    The job definition recovery option.

    getAbendPromptId

    public Identifier getAbendPromptId()
    Returns the identifier of the job definition abend prompt.

    Returns:
    the identifier of the job definition abend prompt.

    getAbendPrompt

    public Prompt getAbendPrompt()
    Returns the job definition abend prompt.

    Returns:
    the job definition abend prompt.

    setTaskString

    public void setTaskString(java.lang.String value)
    Sets the job definition task string.

    Parameters:
    value - The job definition task string.

    setReturnCodeMapping

    public void setReturnCodeMapping(java.lang.String value)
    Sets the job definition return code mapping.

    Parameters:
    value - The job definition return code mapping.

    setInteractive

    public void setInteractive(boolean value)
    Sets the property used to decide if this job definition is interactive.

    Parameters:
    value - True if this job definition is interactive.

    setRecoveryJobId

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

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

    setRecoveryJobKey

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

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

    setRecoveryOption

    public void setRecoveryOption(RecoveryOption value)
    Sets the job definition recovery option.

    Parameters:
    value - The job definition recovery option.

    setAbendPromptId

    public void setAbendPromptId(Identifier identifier)
    Sets the identifier of the job definition abend prompt.

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

    setAbendPrompt

    public void setAbendPrompt(Prompt prompt)
    Sets the job definition abend prompt.

    Parameters:
    prompt - The job definition abend prompt.

    equals

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

    Overrides:
    equals in class JobDefinition
    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 DistJobDefinition object.

    Overrides:
    hashCode in class JobDefinition
    Returns:
    The object's hash code.

    toString

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

    Overrides:
    toString in class JobDefinition
    Returns:
    A text string including all DistJobDefinition fields.


    Copyright © 2005 IBM All Rights Reserved.