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

Interface BatchJobResultAdapter

All Superinterfaces:

com.mulesoft.mule.runtime.module.batch.api.BatchJobResult, Serializable

All Known Implementing Classes:

DefaultBatchJobResult

public interface BatchJobResultAdapter
extends com.mulesoft.mule.runtime.module.batch.api.BatchJobResult

Adapter interface that allows access to functionality that is not to be exposed in the facing API

Method Summary

Modifier and Type	Method and Description
Map<String,com.mulesoft.mule.runtime.module.batch.api.BatchStepResult>	getBatchStepResults() Returns a Map in which the key is the name of a step and the value is a BatchStepResult
long	incrementLoadedRecords(long howMany) Increments the load records count by howMany
void	setInputPhaseException(Exception inputPhaseException) Sets an Exception thrown in the input phase
void	setLoadingPhaseException(Exception loadingPhaseException) Sets an Exception thrown in the loading phase
void	setOnCompletePhaseException(Exception onCompleteStepException) Sets an Exception thrown in the on complete phase
void	setTotalRecords(long totalRecords) sets the amount of total records that make for the owning BatchJobInstance
long	startClock() Starts tracking the time that a BatchJobInstance has been processing since the moment that this method has been invoked.
long	stopClock() Signals that the owning BatchJobInstance has stopped processing at the time this method was invoked
void	updateFor(BatchJobAdapter job, Collection<Record> records) Updates the values in this instance

Methods inherited from interface com.mulesoft.mule.runtime.module.batch.api.BatchJobResult

getBatchJobInstanceId, getElapsedTimeInMillis, getFailedRecords, getInputPhaseException, getLoadedRecords, getLoadingPhaseException, getOnCompletePhaseException, getProcessedRecords, getResultForStep, getSuccessfulRecords, getTotalRecords, isFailedOnCompletePhase, isFailedOnInputPhase, isFailedOnLoadingPhase

Method Detail

startClock

long startClock()

Starts tracking the time that a BatchJobInstance has been processing since the moment that this method has been invoked. After invoking this method, stopClock() has to be invoked at some point so that BatchJobResult.getElapsedTimeInMillis() can eventually return a valid value

Returns:

the instant in milliseconds in which this method was invoked

stopClock

long stopClock()

Signals that the owning BatchJobInstance has stopped processing at the time this method was invoked

Returns:

the time in millis that the owning BatchJobInstance has been processing

incrementLoadedRecords

long incrementLoadedRecords(long howMany)

Increments the load records count by howMany

Parameters:

howMany - the amount of new records that have been loaded

Returns:

the updated count of records that have been loaded

updateFor

void updateFor(BatchJobAdapter job,
               Collection<Record> records)

Updates the values in this instance

Parameters:

job - the owning BatchJobAdapter

records - a collection of Record processed

setTotalRecords

void setTotalRecords(long totalRecords)

sets the amount of total records that make for the owning BatchJobInstance

Parameters:

totalRecords - the total amount of records

setInputPhaseException

void setInputPhaseException(Exception inputPhaseException)

Sets an Exception thrown in the input phase

Parameters:

inputPhaseException - a Exception

setLoadingPhaseException

void setLoadingPhaseException(Exception loadingPhaseException)

Sets an Exception thrown in the loading phase

Parameters:

loadingPhaseException - a Exception

setOnCompletePhaseException

void setOnCompletePhaseException(Exception onCompleteStepException)

Sets an Exception thrown in the on complete phase

Parameters:

onCompleteStepException - a Exception

getBatchStepResults

Map<String,com.mulesoft.mule.runtime.module.batch.api.BatchStepResult> getBatchStepResults()

Returns a Map in which the key is the name of a step and the value is a BatchStepResult