org.alfresco.repo.batch

Interface BatchMonitor

All Known Implementing Classes:

BatchProcessor

public interface BatchMonitor

An interface that allows the monitoring of metrics relating to a potentially long-running batch process.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getCurrentEntryId() Gets the ID of the entry being processed
java.util.Date	getEndTime() Gets the end time.
java.lang.String	getLastError() Gets the stack trace of the last error.
java.lang.String	getLastErrorEntryId() Gets the entry id that caused the last error.
java.lang.String	getPercentComplete() Gets the progress expressed as a percentage.
java.lang.String	getProcessName() Gets the process name.
java.util.Date	getStartTime() Gets the start time.
int	getSuccessfullyProcessedEntries() Gets the number of successfully processed entries.
int	getTotalErrors() Gets the total number of errors.
int	getTotalResults() Gets the total number of results.

Method Detail

getProcessName

java.lang.String getProcessName()

Gets the process name.

Returns:

the process name

getStartTime

java.util.Date getStartTime()

Gets the start time.

Returns:

the start time

getTotalResults

int getTotalResults()

Gets the total number of results.

Returns:

the total number of results

getCurrentEntryId

java.lang.String getCurrentEntryId()

Gets the ID of the entry being processed

Returns:

the current entry id

getSuccessfullyProcessedEntries

int getSuccessfullyProcessedEntries()

Gets the number of successfully processed entries.

Returns:

the successfully processed entries

getPercentComplete

java.lang.String getPercentComplete()

Gets the progress expressed as a percentage.

Returns:

the progress expressed as a percentage

getTotalErrors

int getTotalErrors()

Gets the total number of errors.

Returns:

the total number of errors

getLastError

java.lang.String getLastError()

Gets the stack trace of the last error.

Returns:

the stack trace of the last error

getLastErrorEntryId

java.lang.String getLastErrorEntryId()

Gets the entry id that caused the last error.

Returns:

the last error entry id

getEndTime

java.util.Date getEndTime()

Gets the end time.

Returns:

the end time