Package com.github.toolarium.processing.unit

Interface IProcessingUnitStatus

All Known Implementing Classes:

ProcessingUnitStatus

public interface IProcessingUnitStatus

Defines the processing unit status: Either the getNumberOfSuccessfulUnits() or the getNumberOfFailedUnits() returns a positive number of processed units.

In general the expectation is to have one record, either successful or failed. If both are null or zero then it will be interpreted as hasNext() equals false! This behavior can be defined by the IEmptyProcessingUnitHandler.

Method Summary

Modifier and Type	Method	Description
java.lang.Long	getNumberOfFailedUnits()	Gets the number of failed units processed that were failed in the last run.
java.lang.Long	getNumberOfSuccessfulUnits()	Gets the number of successful units that were processed in the last run.
java.lang.Long	getNumberOfUnprocessedUnits()	Optionally, the number of all unprocessed units can be returned.
ProcessingRuntimeStatus	getProcessingRuntimeStatus()	The processing runtime status for this run.
IProcessingUnitStatistic	getProcessingUnitStatistic()	Get the processing unit statistic of the last call.
java.util.List<java.lang.String>	getStatusMessageList()	A return message can be passed back.
boolean	hasNext()	Defines if there is more to process or not.

Method Detail

hasNext

boolean hasNext()

Defines if there is more to process or not.

Returns:

true if it has more element; otherwise it has ended.

getNumberOfSuccessfulUnits

java.lang.Long getNumberOfSuccessfulUnits()

Gets the number of successful units that were processed in the last run.

Returns:

the number of successful units or null.

getNumberOfFailedUnits

java.lang.Long getNumberOfFailedUnits()

Gets the number of failed units processed that were failed in the last run.

Returns:

the number of failed units or null.

getNumberOfUnprocessedUnits

java.lang.Long getNumberOfUnprocessedUnits()

Optionally, the number of all unprocessed units can be returned.

Returns:

the number of unprocessed units.

getProcessingRuntimeStatus

ProcessingRuntimeStatus getProcessingRuntimeStatus()

The processing runtime status for this run. If it's null then it will be interpreted as successful in the last run.

Returns:

the processing runtime status or null

getStatusMessageList

java.util.List<java.lang.String> getStatusMessageList()

A return message can be passed back. In case it's null then no status message is available in the last run.

Returns:

the status message list or null

getProcessingUnitStatistic

IProcessingUnitStatistic getProcessingUnitStatistic()

Get the processing unit statistic of the last call.

Returns:

the processing unit statistic of last call or null.