Skip navigation links
Batch Applications for the Java Platform 1.0.0.Final
A B C D E G I J M N O P R S V W 

A

abandon(long) - Method in interface javax.batch.operations.JobOperator
Set batch status to ABANDONED.
AbstractBatchlet - Class in javax.batch.api
The AbstractBatchlet provides default implementations of less commonly implemented methods.
AbstractBatchlet() - Constructor for class javax.batch.api.AbstractBatchlet
 
AbstractCheckpointAlgorithm - Class in javax.batch.api.chunk
The AbstractCheckpointAlgorithm provides default implementations of less commonly implemented methods.
AbstractCheckpointAlgorithm() - Constructor for class javax.batch.api.chunk.AbstractCheckpointAlgorithm
 
AbstractChunkListener - Class in javax.batch.api.chunk.listener
The AbstractChunkListener provides default implementations of less commonly implemented methods.
AbstractChunkListener() - Constructor for class javax.batch.api.chunk.listener.AbstractChunkListener
 
AbstractItemProcessListener - Class in javax.batch.api.chunk.listener
The AbstractItemProcessListener provides default implementations of less commonly implemented methods.
AbstractItemProcessListener() - Constructor for class javax.batch.api.chunk.listener.AbstractItemProcessListener
 
AbstractItemReader - Class in javax.batch.api.chunk
The AbstractItemReader provides default implementations of less commonly implemented methods.
AbstractItemReader() - Constructor for class javax.batch.api.chunk.AbstractItemReader
 
AbstractItemReadListener - Class in javax.batch.api.chunk.listener
The AbstractItemReadListener provides default implementations of less commonly implemented methods.
AbstractItemReadListener() - Constructor for class javax.batch.api.chunk.listener.AbstractItemReadListener
 
AbstractItemWriteListener - Class in javax.batch.api.chunk.listener
The AbstractItemWriteListener provides default implementations of less commonly implemented methods.
AbstractItemWriteListener() - Constructor for class javax.batch.api.chunk.listener.AbstractItemWriteListener
 
AbstractItemWriter - Class in javax.batch.api.chunk
The AbstractItemWriter provides default implementations of not commonly implemented methods.
AbstractItemWriter() - Constructor for class javax.batch.api.chunk.AbstractItemWriter
 
AbstractJobListener - Class in javax.batch.api.listener
The AbstractJobListener provides default implementations of less commonly implemented methods.
AbstractJobListener() - Constructor for class javax.batch.api.listener.AbstractJobListener
 
AbstractPartitionAnalyzer - Class in javax.batch.api.partition
The AbstractPartitionAnalyzer provides default implementations of less commonly implemented methods.
AbstractPartitionAnalyzer() - Constructor for class javax.batch.api.partition.AbstractPartitionAnalyzer
 
AbstractPartitionReducer - Class in javax.batch.api.partition
The AbstractBatchlet provides default implementations of less commonly implemented methods.
AbstractPartitionReducer() - Constructor for class javax.batch.api.partition.AbstractPartitionReducer
 
AbstractStepListener - Class in javax.batch.api.listener
The AbstractStepListener provides default implementations of less commonly implemented methods.
AbstractStepListener() - Constructor for class javax.batch.api.listener.AbstractStepListener
 
afterChunk() - Method in class javax.batch.api.chunk.listener.AbstractChunkListener
Override this method if the ChunkListener will do something after the chunk ends.
afterChunk() - Method in interface javax.batch.api.chunk.listener.ChunkListener
The afterChunk method receives control after processing of the current chunk ends.
afterJob() - Method in class javax.batch.api.listener.AbstractJobListener
Override this method if the JobListener will do something after the job ends.
afterJob() - Method in interface javax.batch.api.listener.JobListener
The afterJob method receives control after the job execution ends.
afterPartitionedStepCompletion(PartitionReducer.PartitionStatus) - Method in class javax.batch.api.partition.AbstractPartitionReducer
Override this method to take action after partitioned step processing ends.
afterPartitionedStepCompletion(PartitionReducer.PartitionStatus) - Method in interface javax.batch.api.partition.PartitionReducer
The afterPartitionedStepCompletion method receives control at the end of a partition processing.
afterProcess(Object, Object) - Method in class javax.batch.api.chunk.listener.AbstractItemProcessListener
Override this method if the ItemProcessListener will do something after the item is processed.
afterProcess(Object, Object) - Method in interface javax.batch.api.chunk.listener.ItemProcessListener
The afterProcess method receives control after an item processor processes an item.
afterRead(Object) - Method in class javax.batch.api.chunk.listener.AbstractItemReadListener
Override this method if the ItemReadListener will do something after the item is read.
afterRead(Object) - Method in interface javax.batch.api.chunk.listener.ItemReadListener
The afterRead method receives control after an item reader reads an item.
afterStep() - Method in class javax.batch.api.listener.AbstractStepListener
Override this method if the StepListener will do something after the step ends.
afterStep() - Method in interface javax.batch.api.listener.StepListener
The afterStep method receives control after a step execution ends.
afterWrite(List<Object>) - Method in class javax.batch.api.chunk.listener.AbstractItemWriteListener
Override this method if the ItemWriteListener will do something after the items are written.
afterWrite(List<Object>) - Method in interface javax.batch.api.chunk.listener.ItemWriteListener
The afterWrite method receives control after an item writer writes its items.
analyzeCollectorData(Serializable) - Method in class javax.batch.api.partition.AbstractPartitionAnalyzer
Override this method to analyze PartitionCollector payloads.
analyzeCollectorData(Serializable) - Method in interface javax.batch.api.partition.PartitionAnalyzer
The analyzeCollectorData method receives control each time a Partition collector sends its payload.
analyzeStatus(BatchStatus, String) - Method in class javax.batch.api.partition.AbstractPartitionAnalyzer
Override this method to analyze partition end status.
analyzeStatus(BatchStatus, String) - Method in interface javax.batch.api.partition.PartitionAnalyzer
The analyzeStatus method receives control each time a partition ends.

B

Batchlet - Interface in javax.batch.api
A batchlet is type of batch step that can be used for any type of background processing that does not explicitly call for a chunk oriented approach.
BatchProperty - Annotation Type in javax.batch.api
 
BatchRuntime - Class in javax.batch.runtime
BatchRuntime represents the JSR 352 Batch Runtime.
BatchRuntime() - Constructor for class javax.batch.runtime.BatchRuntime
 
BatchRuntimeException - Exception in javax.batch.operations
 
BatchRuntimeException() - Constructor for exception javax.batch.operations.BatchRuntimeException
 
BatchRuntimeException(String) - Constructor for exception javax.batch.operations.BatchRuntimeException
 
BatchRuntimeException(Throwable) - Constructor for exception javax.batch.operations.BatchRuntimeException
 
BatchRuntimeException(String, Throwable) - Constructor for exception javax.batch.operations.BatchRuntimeException
 
BatchStatus - Enum in javax.batch.runtime
BatchStatus enum defines the batch status values possible for a job.
beforeChunk() - Method in class javax.batch.api.chunk.listener.AbstractChunkListener
Override this method if the ChunkListener will do something before the chunk begins.
beforeChunk() - Method in interface javax.batch.api.chunk.listener.ChunkListener
The beforeChunk method receives control before processing of the next chunk begins.
beforeJob() - Method in class javax.batch.api.listener.AbstractJobListener
Override this method if the JobListener will do something before the job begins.
beforeJob() - Method in interface javax.batch.api.listener.JobListener
The beforeJob method receives control before the job execution begins.
beforePartitionedStepCompletion() - Method in class javax.batch.api.partition.AbstractPartitionReducer
Override this method to take action before normal partitioned step processing ends.
beforePartitionedStepCompletion() - Method in interface javax.batch.api.partition.PartitionReducer
The beforePartitionedStepCompletion method receives control at the end of partitioned step processing.
beforeProcess(Object) - Method in class javax.batch.api.chunk.listener.AbstractItemProcessListener
Override this method if the ItemProcessListener will do something before the item is processed.
beforeProcess(Object) - Method in interface javax.batch.api.chunk.listener.ItemProcessListener
The beforeProcess method receives control before an item processor is called to process the next item.
beforeRead() - Method in class javax.batch.api.chunk.listener.AbstractItemReadListener
Override this method if the ItemReadListener will do something before the item is read.
beforeRead() - Method in interface javax.batch.api.chunk.listener.ItemReadListener
The beforeRead method receives control before an item reader is called to read the next item.
beforeStep() - Method in class javax.batch.api.listener.AbstractStepListener
Override this method if the StepListener will do something before the step begins.
beforeStep() - Method in interface javax.batch.api.listener.StepListener
The beforeStep method receives control before a step execution begins.
beforeWrite(List<Object>) - Method in class javax.batch.api.chunk.listener.AbstractItemWriteListener
Override this method if the ItemWriteListener will do something before the items are written.
beforeWrite(List<Object>) - Method in interface javax.batch.api.chunk.listener.ItemWriteListener
The beforeWrite method receives control before an item writer is called to write its items.
beginCheckpoint() - Method in class javax.batch.api.chunk.AbstractCheckpointAlgorithm
Override this method for the CheckpointAlgorithm to do something before a checkpoint begins.
beginCheckpoint() - Method in interface javax.batch.api.chunk.CheckpointAlgorithm
The beginCheckpoint method is invoked before the next checkpoint interval begins.
beginPartitionedStep() - Method in class javax.batch.api.partition.AbstractPartitionReducer
Override this method to take action before partitioned step processing begins.
beginPartitionedStep() - Method in interface javax.batch.api.partition.PartitionReducer
The beginPartitionedStep method receives control at the start of partition processing.

C

CheckpointAlgorithm - Interface in javax.batch.api.chunk
CheckpointAlgorithm provides a custom checkpoint policy for chunk steps.
checkpointInfo() - Method in class javax.batch.api.chunk.AbstractItemReader
Override this method if the ItemReader supports checkpoints.
checkpointInfo() - Method in class javax.batch.api.chunk.AbstractItemWriter
Override this method if the ItemWriter supports checkpoints.
checkpointInfo() - Method in interface javax.batch.api.chunk.ItemReader
The checkpointInfo method returns the current checkpoint data for this reader.
checkpointInfo() - Method in interface javax.batch.api.chunk.ItemWriter
The checkpointInfo method returns the current checkpoint data for this writer.
checkpointTimeout() - Method in class javax.batch.api.chunk.AbstractCheckpointAlgorithm
Override this method if the CheckpointAlgorithm establishes a checkpoint timeout.
checkpointTimeout() - Method in interface javax.batch.api.chunk.CheckpointAlgorithm
The checkpointTimeout is invoked at the beginning of a new checkpoint interval for the purpose of establishing the checkpoint timeout.
ChunkListener - Interface in javax.batch.api.chunk.listener
ChunkListener intercepts chunk processing.
close() - Method in class javax.batch.api.chunk.AbstractItemReader
Override this method if the ItemReader requires any close time processing.
close() - Method in class javax.batch.api.chunk.AbstractItemWriter
Override this method if the ItemWriter requires any close time processing.
close() - Method in interface javax.batch.api.chunk.ItemReader
The close method marks the end of use of the ItemReader.
close() - Method in interface javax.batch.api.chunk.ItemWriter
The close method marks the end of use of the ItemWriter.
collectPartitionData() - Method in interface javax.batch.api.partition.PartitionCollector
The collectPartitionData method receives control periodically during partition processing.

D

decide(StepExecution[]) - Method in interface javax.batch.api.Decider
The decide method sets a new exit status for a job.
Decider - Interface in javax.batch.api
A Decider receives control as part of a decision element in a job.

E

endCheckpoint() - Method in class javax.batch.api.chunk.AbstractCheckpointAlgorithm
Override this method for the CheckpointAlgorithm to do something after a checkpoint ends.
endCheckpoint() - Method in interface javax.batch.api.chunk.CheckpointAlgorithm
The endCheckpoint method is invoked after the current checkpoint ends.

G

getBatchStatus() - Method in interface javax.batch.runtime.context.JobContext
The getBatchStatus method simply returns the batch status value set by the batch runtime into the job context.
getBatchStatus() - Method in interface javax.batch.runtime.context.StepContext
The getBatchStatus method returns the current batch status of the current step.
getBatchStatus() - Method in interface javax.batch.runtime.JobExecution
Get batch status of this execution.
getBatchStatus() - Method in interface javax.batch.runtime.StepExecution
Get batch status of this step execution.
getCreateTime() - Method in interface javax.batch.runtime.JobExecution
Get time execution was created.
getEndTime() - Method in interface javax.batch.runtime.JobExecution
Get time execution entered end status: COMPLETED, STOPPED, FAILED
getEndTime() - Method in interface javax.batch.runtime.StepExecution
Get time this step ended.
getException() - Method in interface javax.batch.runtime.context.StepContext
The getException method returns the last exception thrown from a step level batch artifact to the batch runtime.
getExecutionId() - Method in interface javax.batch.runtime.context.JobContext
The getExecutionId method returns the current job's current execution id.
getExecutionId() - Method in interface javax.batch.runtime.JobExecution
Get unique id for this JobExecution.
getExitStatus() - Method in interface javax.batch.runtime.context.JobContext
The getExitStatus method simply returns the exit status value stored into the job context through the setExitStatus method or null.
getExitStatus() - Method in interface javax.batch.runtime.context.StepContext
The getExitStatus method simply returns the exit status value stored into the step context through the setExitStatus method or null.
getExitStatus() - Method in interface javax.batch.runtime.JobExecution
Get execution exit status.
getExitStatus() - Method in interface javax.batch.runtime.StepExecution
Get exit status of step.
getInstanceId() - Method in interface javax.batch.runtime.context.JobContext
The getInstanceId method returns the current job's instance id.
getInstanceId() - Method in interface javax.batch.runtime.JobInstance
Get unique id for this JobInstance.
getJobExecution(long) - Method in interface javax.batch.operations.JobOperator
Return job execution for specified execution id
getJobExecutions(JobInstance) - Method in interface javax.batch.operations.JobOperator
Return all job executions belonging to the specified job instance.
getJobInstance(long) - Method in interface javax.batch.operations.JobOperator
Return the job instance for the specified execution id.
getJobInstanceCount(String) - Method in interface javax.batch.operations.JobOperator
Returns number of instances of a job with a particular name.
getJobInstances(String, int, int) - Method in interface javax.batch.operations.JobOperator
Returns all JobInstances belonging to a job with a particular name in reverse chronological order.
getJobName() - Method in interface javax.batch.runtime.context.JobContext
Get job name
getJobName() - Method in interface javax.batch.runtime.JobExecution
Get job name.
getJobName() - Method in interface javax.batch.runtime.JobInstance
Get job name.
getJobNames() - Method in interface javax.batch.operations.JobOperator
Returns a set of all job names known to the batch runtime.
getJobOperator() - Static method in class javax.batch.runtime.BatchRuntime
The getJobOperator factory method returns an instance of the JobOperator interface.
getJobParameters() - Method in interface javax.batch.runtime.JobExecution
Get job parameters for this execution.
getLastUpdatedTime() - Method in interface javax.batch.runtime.JobExecution
Get time execution was last updated updated.
getMetrics() - Method in interface javax.batch.runtime.context.StepContext
The getMetrics method returns an array of step level metrics.
getMetrics() - Method in interface javax.batch.runtime.StepExecution
Get step metrics
getParameters(long) - Method in interface javax.batch.operations.JobOperator
Returns job parameters for a specified job instance.
getPartitionProperties() - Method in interface javax.batch.api.partition.PartitionPlan
Gets array of Partition Properties objects for Partitions.
getPartitionProperties() - Method in class javax.batch.api.partition.PartitionPlanImpl
 
getPartitions() - Method in interface javax.batch.api.partition.PartitionPlan
Gets count of Partitions.
getPartitions() - Method in class javax.batch.api.partition.PartitionPlanImpl
 
getPartitionsOverride() - Method in interface javax.batch.api.partition.PartitionPlan
Return current value of partition override setting.
getPartitionsOverride() - Method in class javax.batch.api.partition.PartitionPlanImpl
 
getPersistentUserData() - Method in interface javax.batch.runtime.context.StepContext
The getPersistentUserData method returns a persistent data object belonging to the current step.
getPersistentUserData() - Method in interface javax.batch.runtime.StepExecution
Get user persistent data
getProperties() - Method in interface javax.batch.runtime.context.JobContext
The getProperties method returns the job level properties specified in a job definition.
getProperties() - Method in interface javax.batch.runtime.context.StepContext
The getProperties method returns the step level properties specified in a job definition.
getRunningExecutions(String) - Method in interface javax.batch.operations.JobOperator
Returns execution ids for job instances with the specified name that have running executions.
getStartTime() - Method in interface javax.batch.runtime.JobExecution
Get time execution entered STARTED status.
getStartTime() - Method in interface javax.batch.runtime.StepExecution
Get time this step started.
getStepExecutionId() - Method in interface javax.batch.runtime.context.StepContext
The getStepExecutionId method returns the current step's execution id.
getStepExecutionId() - Method in interface javax.batch.runtime.StepExecution
Get unique id for this StepExecution.
getStepExecutions(long) - Method in interface javax.batch.operations.JobOperator
Return StepExecutions for specified execution id.
getStepName() - Method in interface javax.batch.runtime.context.StepContext
Get step name
getStepName() - Method in interface javax.batch.runtime.StepExecution
Get step name.
getThreads() - Method in interface javax.batch.api.partition.PartitionPlan
Gets count of threads.
getThreads() - Method in class javax.batch.api.partition.PartitionPlanImpl
 
getTransientUserData() - Method in interface javax.batch.runtime.context.JobContext
The getTransientUserData method returns a transient data object belonging to the current Job XML execution element.
getTransientUserData() - Method in interface javax.batch.runtime.context.StepContext
The getTransientUserData method returns a transient data object belonging to the current Job XML execution element.
getType() - Method in interface javax.batch.runtime.Metric
The getName method returns the metric type.
getValue() - Method in interface javax.batch.runtime.Metric
The getValue method returns the metric value.

I

isReadyToCheckpoint() - Method in class javax.batch.api.chunk.AbstractCheckpointAlgorithm
Implement logic in this method to decide if a checkpoint should be taken now.
isReadyToCheckpoint() - Method in interface javax.batch.api.chunk.CheckpointAlgorithm
The isReadyToCheckpoint method is invoked by the batch runtime after each item processed to determine if now is the time to checkpoint the current chunk.
ItemProcessListener - Interface in javax.batch.api.chunk.listener
ItemProcessListener intercepts item processing.
ItemProcessor - Interface in javax.batch.api.chunk
ItemProcessor is used in chunk processing to operate on an input item and produce an output item.
ItemReader - Interface in javax.batch.api.chunk
ItemReader defines the batch artifact that reads items for chunk processing.
ItemReadListener - Interface in javax.batch.api.chunk.listener
ItemReadListener intercepts item reader processing.
ItemWriteListener - Interface in javax.batch.api.chunk.listener
ItemWriteListener intercepts item writer processing.
ItemWriter - Interface in javax.batch.api.chunk
ItemWriter defines the batch artifact that writes to a list of items for chunk processing.

J

javax.batch.api - package javax.batch.api
Provides APIs used by Batch artifacts.
javax.batch.api.chunk - package javax.batch.api.chunk
Provides APIs used by artifacts in a Batch chunk step.
javax.batch.api.chunk.listener - package javax.batch.api.chunk.listener
Provides APIs defining listener artifacts for a Batch chunk step.
javax.batch.api.listener - package javax.batch.api.listener
Provides APIs defining Batch job-level and step-level listener artifacts.
javax.batch.api.partition - package javax.batch.api.partition
Provides APIs for artifacts specific to a Batch partitioned step.
javax.batch.operations - package javax.batch.operations
Provides APIs for starting, managing, and viewing results of Batch job executions, along with a set of exceptions.
javax.batch.runtime - package javax.batch.runtime
Provides APIs for viewing the detailed outcomes and metrics of Batch job executions.
javax.batch.runtime.context - package javax.batch.runtime.context
Provides APIs for context classes allowing data sharing across Batch artifacts within a job instance and within a step.
JobContext - Interface in javax.batch.runtime.context
 
JobExecution - Interface in javax.batch.runtime
 
JobExecutionAlreadyCompleteException - Exception in javax.batch.operations
 
JobExecutionAlreadyCompleteException() - Constructor for exception javax.batch.operations.JobExecutionAlreadyCompleteException
 
JobExecutionAlreadyCompleteException(String) - Constructor for exception javax.batch.operations.JobExecutionAlreadyCompleteException
 
JobExecutionAlreadyCompleteException(Throwable) - Constructor for exception javax.batch.operations.JobExecutionAlreadyCompleteException
 
JobExecutionAlreadyCompleteException(String, Throwable) - Constructor for exception javax.batch.operations.JobExecutionAlreadyCompleteException
 
JobExecutionIsRunningException - Exception in javax.batch.operations
 
JobExecutionIsRunningException() - Constructor for exception javax.batch.operations.JobExecutionIsRunningException
 
JobExecutionIsRunningException(String) - Constructor for exception javax.batch.operations.JobExecutionIsRunningException
 
JobExecutionIsRunningException(Throwable) - Constructor for exception javax.batch.operations.JobExecutionIsRunningException
 
JobExecutionIsRunningException(String, Throwable) - Constructor for exception javax.batch.operations.JobExecutionIsRunningException
 
JobExecutionNotMostRecentException - Exception in javax.batch.operations
 
JobExecutionNotMostRecentException() - Constructor for exception javax.batch.operations.JobExecutionNotMostRecentException
 
JobExecutionNotMostRecentException(String) - Constructor for exception javax.batch.operations.JobExecutionNotMostRecentException
 
JobExecutionNotMostRecentException(Throwable) - Constructor for exception javax.batch.operations.JobExecutionNotMostRecentException
 
JobExecutionNotMostRecentException(String, Throwable) - Constructor for exception javax.batch.operations.JobExecutionNotMostRecentException
 
JobExecutionNotRunningException - Exception in javax.batch.operations
 
JobExecutionNotRunningException() - Constructor for exception javax.batch.operations.JobExecutionNotRunningException
 
JobExecutionNotRunningException(String) - Constructor for exception javax.batch.operations.JobExecutionNotRunningException
 
JobExecutionNotRunningException(Throwable) - Constructor for exception javax.batch.operations.JobExecutionNotRunningException
 
JobExecutionNotRunningException(String, Throwable) - Constructor for exception javax.batch.operations.JobExecutionNotRunningException
 
JobInstance - Interface in javax.batch.runtime
 
JobListener - Interface in javax.batch.api.listener
JobListener intercepts job execution.
JobOperator - Interface in javax.batch.operations
JobOperator provide the interface for operating on batch jobs.
JobRestartException - Exception in javax.batch.operations
 
JobRestartException() - Constructor for exception javax.batch.operations.JobRestartException
JobRestartException is thrown when an error occurs during the JobOperator restart operation.
JobRestartException(String) - Constructor for exception javax.batch.operations.JobRestartException
 
JobRestartException(Throwable) - Constructor for exception javax.batch.operations.JobRestartException
 
JobRestartException(String, Throwable) - Constructor for exception javax.batch.operations.JobRestartException
 
JobSecurityException - Exception in javax.batch.operations
 
JobSecurityException() - Constructor for exception javax.batch.operations.JobSecurityException
SecurityException is thrown when an user is not authorized to run a JobOperator method, such as restart, stop, abandon, any getters, etc
JobSecurityException(String) - Constructor for exception javax.batch.operations.JobSecurityException
 
JobSecurityException(Throwable) - Constructor for exception javax.batch.operations.JobSecurityException
 
JobSecurityException(String, Throwable) - Constructor for exception javax.batch.operations.JobSecurityException
 
JobStartException - Exception in javax.batch.operations
 
JobStartException() - Constructor for exception javax.batch.operations.JobStartException
JobStartException is thrown when an error occurs during the JobOperator start operation.
JobStartException(String) - Constructor for exception javax.batch.operations.JobStartException
 
JobStartException(Throwable) - Constructor for exception javax.batch.operations.JobStartException
 
JobStartException(String, Throwable) - Constructor for exception javax.batch.operations.JobStartException
 

M

mapPartitions() - Method in interface javax.batch.api.partition.PartitionMapper
The mapPartitions method that receives control at the start of partitioned step processing.
Metric - Interface in javax.batch.runtime
The Metric interface defines job metrics recorded by the batch runtime.
Metric.MetricType - Enum in javax.batch.runtime
 

N

NoSuchJobException - Exception in javax.batch.operations
 
NoSuchJobException() - Constructor for exception javax.batch.operations.NoSuchJobException
 
NoSuchJobException(String) - Constructor for exception javax.batch.operations.NoSuchJobException
 
NoSuchJobException(Throwable) - Constructor for exception javax.batch.operations.NoSuchJobException
 
NoSuchJobException(String, Throwable) - Constructor for exception javax.batch.operations.NoSuchJobException
 
NoSuchJobExecutionException - Exception in javax.batch.operations
 
NoSuchJobExecutionException() - Constructor for exception javax.batch.operations.NoSuchJobExecutionException
 
NoSuchJobExecutionException(String) - Constructor for exception javax.batch.operations.NoSuchJobExecutionException
 
NoSuchJobExecutionException(Throwable) - Constructor for exception javax.batch.operations.NoSuchJobExecutionException
 
NoSuchJobExecutionException(String, Throwable) - Constructor for exception javax.batch.operations.NoSuchJobExecutionException
 
NoSuchJobInstanceException - Exception in javax.batch.operations
 
NoSuchJobInstanceException() - Constructor for exception javax.batch.operations.NoSuchJobInstanceException
 
NoSuchJobInstanceException(String) - Constructor for exception javax.batch.operations.NoSuchJobInstanceException
 
NoSuchJobInstanceException(Throwable) - Constructor for exception javax.batch.operations.NoSuchJobInstanceException
 
NoSuchJobInstanceException(String, Throwable) - Constructor for exception javax.batch.operations.NoSuchJobInstanceException
 

O

onError(Exception) - Method in class javax.batch.api.chunk.listener.AbstractChunkListener
Override this method if the ChunkListener will do something before the chunk transaction is rolled back.
onError(Exception) - Method in interface javax.batch.api.chunk.listener.ChunkListener
The onError method receives control before the chunk transaction is rolled back.
onProcessError(Object, Exception) - Method in class javax.batch.api.chunk.listener.AbstractItemProcessListener
Override this method if the ItemProcessListener will do something when the ItemProcessor processItem method throws an exception.
onProcessError(Object, Exception) - Method in interface javax.batch.api.chunk.listener.ItemProcessListener
The afterProcess method receives control after an item processor processes an item.
onReadError(Exception) - Method in class javax.batch.api.chunk.listener.AbstractItemReadListener
Override this method if the ItemReadListener will do something when the ItemReader readItem method throws an exception.
onReadError(Exception) - Method in interface javax.batch.api.chunk.listener.ItemReadListener
The onReadError method receives control after an item reader throws an exception in the readItem method.
onRetryProcessException(Object, Exception) - Method in interface javax.batch.api.chunk.listener.RetryProcessListener
The onRetryProcessException method receives control when a retryable exception is thrown from an ItemProcessor processItem method.
onRetryReadException(Exception) - Method in interface javax.batch.api.chunk.listener.RetryReadListener
The onRetryReadException method receives control when a retryable exception is thrown from an ItemReader readItem method.
onRetryWriteException(List<Object>, Exception) - Method in interface javax.batch.api.chunk.listener.RetryWriteListener
The onRetryWriteException method receives control when a retryable exception is thrown from an ItemWriter writeItems method.
onSkipProcessItem(Object, Exception) - Method in interface javax.batch.api.chunk.listener.SkipProcessListener
The onSkipProcessItem method receives control when a skippable exception is thrown from an ItemProcess processItem method.
onSkipReadItem(Exception) - Method in interface javax.batch.api.chunk.listener.SkipReadListener
The onSkipReadItem method receives control when a skippable exception is thrown from an ItemReader readItem method.
onSkipWriteItem(List<Object>, Exception) - Method in interface javax.batch.api.chunk.listener.SkipWriteListener
The onSkipWriteItems method receives control when a skippable exception is thrown from an ItemWriter writeItems method.
onWriteError(List<Object>, Exception) - Method in class javax.batch.api.chunk.listener.AbstractItemWriteListener
Override this method if the ItemWriteListener will do something when the ItemWriter writeItems method throws an exception.
onWriteError(List<Object>, Exception) - Method in interface javax.batch.api.chunk.listener.ItemWriteListener
The onWriteError method receives control after an item writer writeItems throws an exception.
open(Serializable) - Method in class javax.batch.api.chunk.AbstractItemReader
Override this method if the ItemReader requires any open time processing.
open(Serializable) - Method in class javax.batch.api.chunk.AbstractItemWriter
Override this method if the ItemWriter requires any open time processing.
open(Serializable) - Method in interface javax.batch.api.chunk.ItemReader
The open method prepares the reader to read items.
open(Serializable) - Method in interface javax.batch.api.chunk.ItemWriter
The open method prepares the writer to write items.

P

PartitionAnalyzer - Interface in javax.batch.api.partition
PartitionAnalyzer receives control to process data and final results from each partition.
PartitionCollector - Interface in javax.batch.api.partition
PartitionCollector provides a way to pass data from individual partitions to a single point of control running on the step's parent thread.
PartitionMapper - Interface in javax.batch.api.partition
PartitionMapper receives control at the start of a partitioned execution.
PartitionPlan - Interface in javax.batch.api.partition
 
PartitionPlanImpl - Class in javax.batch.api.partition
The PartitionPlanImpl class provides a basic implementation of the PartitionPlan interface.
PartitionPlanImpl() - Constructor for class javax.batch.api.partition.PartitionPlanImpl
 
PartitionReducer - Interface in javax.batch.api.partition
PartitionReducer provides unit of work demarcation across partitions.
PartitionReducer.PartitionStatus - Enum in javax.batch.api.partition
 
process() - Method in class javax.batch.api.AbstractBatchlet
Implement process logic for the Batchlet in this method.
process() - Method in interface javax.batch.api.Batchlet
The process method does the work of the batchlet.
processItem(Object) - Method in interface javax.batch.api.chunk.ItemProcessor
The processItem method is part of a chunk step.

R

readItem() - Method in class javax.batch.api.chunk.AbstractItemReader
Implement read logic for the ItemReader in this method.
readItem() - Method in interface javax.batch.api.chunk.ItemReader
The readItem method returns the next item for chunk processing.
restart(long, Properties) - Method in interface javax.batch.operations.JobOperator
Restarts a failed or stopped job instance.
RetryProcessListener - Interface in javax.batch.api.chunk.listener
RetryProcessListener intercepts retry processing for an ItemProcessor.
RetryReadListener - Interface in javax.batch.api.chunk.listener
RetryReadListener intercepts retry processing for an ItemReader.
RetryWriteListener - Interface in javax.batch.api.chunk.listener
RetryWriteListener intercepts retry processing for an ItemWriter.
rollbackPartitionedStep() - Method in class javax.batch.api.partition.AbstractPartitionReducer
Override this method to take action when a partitioned step is rolling back.
rollbackPartitionedStep() - Method in interface javax.batch.api.partition.PartitionReducer
The rollbackPartitionedStep method receives control if the runtime is rolling back a partitioned step.

S

setExitStatus(String) - Method in interface javax.batch.runtime.context.JobContext
The setExitStatus method assigns the user-specified exit status for the current job.
setExitStatus(String) - Method in interface javax.batch.runtime.context.StepContext
The setExitStatus method assigns the user-specified exit status for the current step.
setPartitionProperties(Properties[]) - Method in interface javax.batch.api.partition.PartitionPlan
Sets array of substitution Properties objects for the set of Partitions.
setPartitionProperties(Properties[]) - Method in class javax.batch.api.partition.PartitionPlanImpl
 
setPartitions(int) - Method in interface javax.batch.api.partition.PartitionPlan
Set number of partitions.
setPartitions(int) - Method in class javax.batch.api.partition.PartitionPlanImpl
 
setPartitionsOverride(boolean) - Method in interface javax.batch.api.partition.PartitionPlan
Specify whether or not to override the partition count from the previous job execution.
setPartitionsOverride(boolean) - Method in class javax.batch.api.partition.PartitionPlanImpl
 
setPersistentUserData(Serializable) - Method in interface javax.batch.runtime.context.StepContext
The setPersistentUserData method stores a persistent data object into the current step.
setThreads(int) - Method in interface javax.batch.api.partition.PartitionPlan
Set number of threads.
setThreads(int) - Method in class javax.batch.api.partition.PartitionPlanImpl
 
setTransientUserData(Object) - Method in interface javax.batch.runtime.context.JobContext
The setTransientUserData method stores a transient data object into the current batch context.
setTransientUserData(Object) - Method in interface javax.batch.runtime.context.StepContext
The setTransientUserData method stores a transient data object into the current batch context.
SkipProcessListener - Interface in javax.batch.api.chunk.listener
SkipProcessListener intercepts skippable itemProcess exception handling.
SkipReadListener - Interface in javax.batch.api.chunk.listener
SkipReadListener intercepts skippable itemReader exception handling.
SkipWriteListener - Interface in javax.batch.api.chunk.listener
SkipWriteListener intercepts skippable itemWriter exception handling.
start(String, Properties) - Method in interface javax.batch.operations.JobOperator
Creates a new job instance and starts the first execution of that instance.
StepContext - Interface in javax.batch.runtime.context
 
StepExecution - Interface in javax.batch.runtime
 
StepListener - Interface in javax.batch.api.listener
StepListener intercepts step execution.
stop() - Method in class javax.batch.api.AbstractBatchlet
Override this method if the Batchlet will end in response to the JobOperator.stop() operation.
stop() - Method in interface javax.batch.api.Batchlet
The stop method is invoked by the batch runtime as part of JobOperator.stop() method processing.
stop(long) - Method in interface javax.batch.operations.JobOperator
Request a running job execution stops.

V

valueOf(String) - Static method in enum javax.batch.api.partition.PartitionReducer.PartitionStatus
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum javax.batch.runtime.BatchStatus
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum javax.batch.runtime.Metric.MetricType
Returns the enum constant of this type with the specified name.
values() - Static method in enum javax.batch.api.partition.PartitionReducer.PartitionStatus
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum javax.batch.runtime.BatchStatus
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum javax.batch.runtime.Metric.MetricType
Returns an array containing the constants of this enum type, in the order they are declared.

W

writeItems(List<Object>) - Method in class javax.batch.api.chunk.AbstractItemWriter
Implement write logic for the ItemWriter in this method.
writeItems(List<Object>) - Method in interface javax.batch.api.chunk.ItemWriter
The writeItems method writes a list of item for the current chunk.
A B C D E G I J M N O P R S V W 
Skip navigation links
Batch Applications for the Java Platform 1.0.0.Final

Copyright © 2014 JBoss by Red Hat. All rights reserved.