com.mulesoft.mule.runtime.module.batch.internal

Class ImmutableBatchJobResult

java.lang.Object

com.mulesoft.mule.runtime.module.batch.internal.ImmutableBatchJobResult

All Implemented Interfaces:

BatchJobResult, Serializable

public final class ImmutableBatchJobResult
extends Object
implements BatchJobResult

Immutable view of ImmutableBatchJobResult

Since:

3.5.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ImmutableBatchJobResult(BatchJobResult jobResult)

Method Summary

Modifier and Type	Method and Description
String	getBatchJobInstanceId() The id of the owning BatchJobInstance
long	getElapsedTimeInMillis() How many milliseconds the BatchJobInstance has been in executing state.
long	getFailedRecords() How many records were processed and failed in at least one step
Exception	getInputPhaseException() If the input phase failed, this method returns an exception info object
long	getLoadedRecords() How many records were loaded so far.
Exception	getLoadingPhaseException() If the loading phase failed, this method returns an exception info object
Exception	getOnCompletePhaseException() If the on complete phase failed, this method returns an exception info object
long	getProcessedRecords() How many records already went through all steps so far.
BatchStepResult	getResultForStep(String stepId) Retrieves information about the execution of a particular step
long	getSuccessfulRecords() How many records were processed through all the steps without failing any of them
long	getTotalRecords() Total number of records in the batch
boolean	isFailedOnCompletePhase() Wether an exeption was found on the on complete phase
boolean	isFailedOnInputPhase() Wether an exeption was found on the on input phase
boolean	isFailedOnLoadingPhase() Wether an exeption was found on the on loading phase

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ImmutableBatchJobResult

public ImmutableBatchJobResult(BatchJobResult jobResult)

Method Detail

getResultForStep

public BatchStepResult getResultForStep(String stepId)

Description copied from interface: BatchJobResult

Retrieves information about the execution of a particular step

Specified by:

getResultForStep in interface BatchJobResult

Parameters:

stepId - the id of a step in the owning BatchJob

Returns:

a BatchStepResult

getElapsedTimeInMillis

public long getElapsedTimeInMillis()

Description copied from interface: BatchJobResult

How many milliseconds the BatchJobInstance has been in executing state. If the job is stopped and then resumed, this method is smart enough to filter the interval

Specified by:

getElapsedTimeInMillis in interface BatchJobResult

getSuccessfulRecords

public long getSuccessfulRecords()

Description copied from interface: BatchJobResult

How many records were processed through all the steps without failing any of them

Specified by:

getSuccessfulRecords in interface BatchJobResult

getFailedRecords

public long getFailedRecords()

Description copied from interface: BatchJobResult

How many records were processed and failed in at least one step

Specified by:

getFailedRecords in interface BatchJobResult

getTotalRecords

public long getTotalRecords()

Description copied from interface: BatchJobResult

Total number of records in the batch

Specified by:

getTotalRecords in interface BatchJobResult

getLoadedRecords

public long getLoadedRecords()

Description copied from interface: BatchJobResult

How many records were loaded so far. When loading phase has finished, this method's return value should match the one of BatchJobResult.getTotalRecords()

Specified by:

getLoadedRecords in interface BatchJobResult

getProcessedRecords

public long getProcessedRecords()

Description copied from interface: BatchJobResult

How many records already went through all steps so far. When execution phase has finished, this method's return value should match the one of BatchJobResult.getTotalRecords()

Specified by:

getProcessedRecords in interface BatchJobResult

getBatchJobInstanceId

public String getBatchJobInstanceId()

Description copied from interface: BatchJobResult

The id of the owning BatchJobInstance

Specified by:

getBatchJobInstanceId in interface BatchJobResult

Returns:

a non empty String

isFailedOnInputPhase

public boolean isFailedOnInputPhase()

Description copied from interface: BatchJobResult

Wether an exeption was found on the on input phase

Specified by:

isFailedOnInputPhase in interface BatchJobResult

getInputPhaseException

public Exception getInputPhaseException()

Description copied from interface: BatchJobResult

If the input phase failed, this method returns an exception info object

Specified by:

getInputPhaseException in interface BatchJobResult

Returns:

a Exception

isFailedOnLoadingPhase

public boolean isFailedOnLoadingPhase()

Description copied from interface: BatchJobResult

Wether an exeption was found on the on loading phase

Specified by:

isFailedOnLoadingPhase in interface BatchJobResult

getLoadingPhaseException

public Exception getLoadingPhaseException()

Description copied from interface: BatchJobResult

If the loading phase failed, this method returns an exception info object

Specified by:

getLoadingPhaseException in interface BatchJobResult

Returns:

a Exception

isFailedOnCompletePhase

public boolean isFailedOnCompletePhase()

Description copied from interface: BatchJobResult

Wether an exeption was found on the on complete phase

Specified by:

isFailedOnCompletePhase in interface BatchJobResult

getOnCompletePhaseException

public Exception getOnCompletePhaseException()

Description copied from interface: BatchJobResult

If the on complete phase failed, this method returns an exception info object

Specified by:

getOnCompletePhaseException in interface BatchJobResult

Returns:

a Exception