com.ibm.websphere.batch
Class BatchConstants

java.lang.Object
  extended by com.ibm.websphere.batch.BatchConstants

public final class BatchConstants
extends java.lang.Object

The following constants are used as return codes for the processJobStep method of a Batch Step EJB. They indicate to the grid endpoint what action to take when a call to processJobStep returns.


Field Summary
static java.lang.String DEFAULT_APPLICATION_NAME
          The DEFAULT_APPLICATION_NAME is available to the BDS datastreams.
static java.lang.String IS_JOB_RESTART
          Used to inform the BDS Streams whether the job is restarting or not in the form of properties.
static java.lang.String JOB_ID
           
static int STEP_COMPLETE
          The STEP_COMPLETE return code indicates that the step has finished processing and signals the grid endpoint to stop invoking the Batch Step EJB.
static int STEP_COMPLETE_EXECUTION_FAILED
          The STEP_COMPLETE_EXECUTION_FAILED return code indicates that the step has finished processing and signals the grid endpoint to stop invoking the Batch Step EJB and to terminate job processing with a job state of execution failed (9).
static int STEP_COMPLETE_FORCE_CHECKPOINT
          The STEP_COMPLETE_FORCE_CHECKPOINT return code indicates that the step has finished processing and signals the grid endpoint to ignore the checkpoint policy applied to the step and force a checkpoint, and to stop invoking the Batch Step EJB.
static int STEP_COMPLETE_FORCE_CHECKPOINT_BEFORE_PROCESSING_CANCEL
          The STEP_COMPLETE_FORCE_CHECKPOINT_BEFORE_PROCESSING_CANCEL return code signals the grid endpoint to ignore the checkpoint policy applied to the step and force a checkpoint before processing any pending cancel request for the job.
static int STEP_CONTINUE
          The STEP_CONTINUE return code indicates that the step has not finished processing and signals the grid endpoint to continue invoking the Batch Step EJB.
static int STEP_CONTINUE_FORCE_CHECKPOINT
          The STEP_CONTINUE_FORCE_CHECKPOINT return code indicates that the step has not finished processing and signals the grid endpoint to ignore the checkpoint policy applied to the step and force a checkpoint, and then continue invoking the Batch Step EJB with the checkpoint policy.
static int STEP_CONTINUE_FORCE_CHECKPOINT_BEFORE_PROCESSING_CANCEL
          The STEP_CONTINUE_FORCE_CHECKPOINT_BEFORE_PROCESSING_CANCEL return code signals the grid endpoint to ignore the checkpoint policy applied to the step and force a checkpoint before processing any pending cancel request for the job.
static java.lang.String STEP_ID
           
 
Constructor Summary
BatchConstants()
           
 
Method Summary
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

STEP_COMPLETE

public static final int STEP_COMPLETE
The STEP_COMPLETE return code indicates that the step has finished processing and signals the grid endpoint to stop invoking the Batch Step EJB.

See Also:
Constant Field Values

STEP_CONTINUE

public static final int STEP_CONTINUE
The STEP_CONTINUE return code indicates that the step has not finished processing and signals the grid endpoint to continue invoking the Batch Step EJB.

See Also:
Constant Field Values

STEP_CONTINUE_FORCE_CHECKPOINT

public static final int STEP_CONTINUE_FORCE_CHECKPOINT
The STEP_CONTINUE_FORCE_CHECKPOINT return code indicates that the step has not finished processing and signals the grid endpoint to ignore the checkpoint policy applied to the step and force a checkpoint, and then continue invoking the Batch Step EJB with the checkpoint policy.

See Also:
Constant Field Values

STEP_COMPLETE_FORCE_CHECKPOINT

public static final int STEP_COMPLETE_FORCE_CHECKPOINT
The STEP_COMPLETE_FORCE_CHECKPOINT return code indicates that the step has finished processing and signals the grid endpoint to ignore the checkpoint policy applied to the step and force a checkpoint, and to stop invoking the Batch Step EJB.

See Also:
Constant Field Values

STEP_CONTINUE_FORCE_CHECKPOINT_BEFORE_PROCESSING_CANCEL

public static final int STEP_CONTINUE_FORCE_CHECKPOINT_BEFORE_PROCESSING_CANCEL
The STEP_CONTINUE_FORCE_CHECKPOINT_BEFORE_PROCESSING_CANCEL return code signals the grid endpoint to ignore the checkpoint policy applied to the step and force a checkpoint before processing any pending cancel request for the job. If a cancel request is pending for the job, the cancel request is honored after the checkpoint is taken. If no cancel request is pending for the job, the grid endpoint is to continue invoking the Batch Step EJB with the checkpoint policy.

See Also:
Constant Field Values

STEP_COMPLETE_FORCE_CHECKPOINT_BEFORE_PROCESSING_CANCEL

public static final int STEP_COMPLETE_FORCE_CHECKPOINT_BEFORE_PROCESSING_CANCEL
The STEP_COMPLETE_FORCE_CHECKPOINT_BEFORE_PROCESSING_CANCEL return code signals the grid endpoint to ignore the checkpoint policy applied to the step and force a checkpoint before processing any pending cancel request for the job. If a cancel request is pending for the job, the cancel request is honored after the checkpoint is taken. The grid endpoint is to stop invoking the Batch Step EJB.

See Also:
Constant Field Values

STEP_COMPLETE_EXECUTION_FAILED

public static final int STEP_COMPLETE_EXECUTION_FAILED
The STEP_COMPLETE_EXECUTION_FAILED return code indicates that the step has finished processing and signals the grid endpoint to stop invoking the Batch Step EJB and to terminate job processing with a job state of execution failed (9).

See Also:
Constant Field Values

JOB_ID

public static final java.lang.String JOB_ID
See Also:
Constant Field Values

STEP_ID

public static final java.lang.String STEP_ID
See Also:
Constant Field Values

DEFAULT_APPLICATION_NAME

public static final java.lang.String DEFAULT_APPLICATION_NAME
The DEFAULT_APPLICATION_NAME is available to the BDS datastreams. It is primarily used by the CursorHoldableJDBCReader to construct the JNDI name for stateful session bean for cursor holdability

See Also:
Constant Field Values

IS_JOB_RESTART

public static final java.lang.String IS_JOB_RESTART
Used to inform the BDS Streams whether the job is restarting or not in the form of properties.

See Also:
Constant Field Values
Constructor Detail

BatchConstants

public BatchConstants()