com.canto.cumulus.prefs

Class SchedulerJobStatistics

java.lang.Object

com.canto.cumulus.prefs.BaseManager

com.canto.cumulus.prefs.SchedulerJobStatistics

public class SchedulerJobStatistics
extends BaseManager

This class stores the job statistics for a scheduler job.

See Also:

SchedulerJob, SchedulerJob.getJobStatistics()

Nested Class Summary

Nested classes/interfaces inherited from class com.canto.cumulus.prefs.BaseManager

BaseManager.PackEntryChangeListener, BaseManager.RegistryEntry

Field Summary

Fields

Modifier and Type	Field and Description
static int	STATUS_OPTION_ERROR
static int	STATUS_OPTION_EXECUTING
static int	STATUS_OPTION_NOT_YET_EXECUTED
static int	STATUS_OPTION_SUCCESSFUL

Fields inherited from class com.canto.cumulus.prefs.BaseManager

TYPE_EJP, TYPE_NATIVE

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getErrorMessage() Returns an error message if an error happened while executing this job.
java.util.Date	getLastRun() Returns the date of the last run of this job.
java.util.Date	getNextStart() Returns the next start date for this job.
int	getStatus() Returns the status of this job after execution.
void	setErrorMessage(java.lang.String msg) Sets the error message for this job.
void	setLastRun(java.util.Date date) Sets the given date as date of the last run.
void	setNextStart(java.util.Date date) Sets the next start date to use for this job.
void	setStatus(int status) Sets the status of this job after execution.

Methods inherited from class com.canto.cumulus.prefs.BaseManager

addChangeListener, addChangeListener, addGlobalChangeListener, addPackListener, forgetPush, getPack, isShared, popPack, pushPack, removeChangeListener, removeChangeListener, removeGlobalChangeListener, removePackListener, save, save, toString, writeAsXML

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

STATUS_OPTION_NOT_YET_EXECUTED

public static final int STATUS_OPTION_NOT_YET_EXECUTED

See Also:

Constant Field Values

STATUS_OPTION_EXECUTING

public static final int STATUS_OPTION_EXECUTING

See Also:

Constant Field Values

STATUS_OPTION_SUCCESSFUL

public static final int STATUS_OPTION_SUCCESSFUL

See Also:

Constant Field Values

STATUS_OPTION_ERROR

public static final int STATUS_OPTION_ERROR

See Also:

Constant Field Values

Method Detail

getErrorMessage

public java.lang.String getErrorMessage()

Returns an error message if an error happened while executing this job.

Returns:

the error message or an empty string

setErrorMessage

public void setErrorMessage(java.lang.String msg)

Sets the error message for this job. This message gets only called from the scheduler server.

Parameters:

msg - the new error message

getNextStart

public java.util.Date getNextStart()

Returns the next start date for this job. This information is calculated based on the job configuration after executing this job and only stored in the statistics. The configuration start time will not be updated.

Returns:

the next start date or null if not yet calculated

setNextStart

public void setNextStart(java.util.Date date)

Sets the next start date to use for this job.

Parameters:

date - start date to use for this job

getLastRun

public java.util.Date getLastRun()

Returns the date of the last run of this job.

Returns:

the last run date or null if not yet executed

Since:

8.1.2

setLastRun

public void setLastRun(java.util.Date date)

Sets the given date as date of the last run.

Parameters:

date - last run date to store

Since:

8.1.2

getStatus

public int getStatus()

Returns the status of this job after execution. The available values are STATUS_OPTION_SUCCESSFUL, STATUS_OPTION_EXECUTING, STATUS_OPTION_NOT_YET_EXECUTED and STATUS_OPTION_ERROR. Defaults to STATUS_OPTION_NOT_YET_EXECUTED

Returns:

status of this job after the ;as execution

setStatus

public void setStatus(int status)

Sets the status of this job after execution. The available values are STATUS_OPTION_SUCCESSFUL, STATUS_OPTION_EXECUTING, STATUS_OPTION_NOT_YET_EXECUTED and STATUS_OPTION_ERROR. This method usually is only called by the scheduler server.

Parameters:

status - the new status information of this jobs last execution