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!

    • 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.
        Returns:
        the number of successful units or null.

      • getNumberOfFailedUnits

        java.lang.Long getNumberOfFailedUnits()
        Gets the number of failed units processed in this run.
        Returns:
        the number of failed units or null.

      • getNumberOfUnprocessedUnits

        java.lang.Long getNumberOfUnprocessedUnits()
        Optional the number of 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.
        Returns:
        the processing runtime status or null

      • getStatusMessage

        java.lang.String getStatusMessage()
        A return message can be passed. In case it's null then no status message is available.
        Returns:
        a status message or null

      • getProcessingUnitStatistic

        IProcessingUnitStatistic getProcessingUnitStatistic()
        Get the processing unit statistic just a the last call.
        Returns:
        the processing unit statistic of last call or null.