com.groiss.timer

Interface TimerEntry

All Superinterfaces:

Activatable, KeyValuePair<String,String>, Persistent, Serializable

public interface TimerEntry
extends Persistent, Activatable

The TimerEntry interface defines the properties of a timer entry. Use the administration tool for manupulating this objects.

Field Summary

Fields inherited from interface com.groiss.store.Persistent

emptyKeys

Method Summary

Modifier and Type	Method and Description
boolean	getActive() Returns whether the entry is active (action will be executed) or not.
String	getArgs() Returns the argument for the timer task.
String	getClassname() Get the classname for the entry.
String	getDescription()
Date	getEffectiveScheduleDate() Get the real schedule date of a timer run.
Date	getFirstTime() Get the first time of scheuling the timer task.
String	getId() Get the id for the entry
Date	getLastRun() Last run (start time) of this timer.
Date	getLastRunEnd() Last run (end time) of this timer.
Date	getNominalScheduleDate() Get the nominal (original) schedule for a timer run.
String	getPattern() Get the period for the entry
boolean	getRunEverywhere() Returns whether the entry should be running on each node in a cluster.
boolean	getRunOnStartup() Run on startup?
String	getThreadId() Get the thread-id for the entry
void	setArgs(String args)
void	setClassname(String classname)
void	setDescription(String desc)
void	setFirstTime(Date d)
void	setId(String id)
void	setPattern(String pattern)
void	setRunEverywhere(boolean everywhere)
void	setRunOnStartup(boolean run)
void	setThreadId(String id)

Methods inherited from interface com.groiss.store.Persistent

afterDelete, afterInsert, afterRead, afterUpdate, beforeDelete, beforeInsert, beforeUpdate, dbFields, getKey, getKeys, getLocalClassName, getLocalObjectName, getOid, getStore, getTableName, getValue, isFilled, isValid, setFilled, setOid, setOid, setStore, toListString

Methods inherited from interface com.groiss.store.Activatable

isActive, setActive

Method Detail

getId

String getId()

Get the id for the entry

setId

void setId(String id)

getClassname

String getClassname()

Get the classname for the entry. This field contains the name of the class of the timer task which implements what is really done, when this entry is scheduled.

setClassname

void setClassname(String classname)

getArgs

String getArgs()

Returns the argument for the timer task.

setArgs

void setArgs(String args)

getFirstTime

Date getFirstTime()

Get the first time of scheuling the timer task.

setFirstTime

void setFirstTime(Date d)

getPattern

String getPattern()

Get the period for the entry

setPattern

void setPattern(String pattern)

getActive

boolean getActive()

Returns whether the entry is active (action will be executed) or not.

getThreadId

String getThreadId()

Get the thread-id for the entry

setThreadId

void setThreadId(String id)

getDescription

String getDescription()

setDescription

void setDescription(String desc)

getRunOnStartup

boolean getRunOnStartup()

Run on startup?

setRunOnStartup

void setRunOnStartup(boolean run)

getRunEverywhere

boolean getRunEverywhere()

Returns whether the entry should be running on each node in a cluster.

setRunEverywhere

void setRunEverywhere(boolean everywhere)

getNominalScheduleDate

Date getNominalScheduleDate()

Get the nominal (original) schedule for a timer run. May be null.

Returns:

the nominal schedule for a timer run.

getEffectiveScheduleDate

Date getEffectiveScheduleDate()

Get the real schedule date of a timer run. May be null.

Returns:

the effective schedule date of a timer run.

getLastRun

Date getLastRun()

Last run (start time) of this timer.

Returns:

a date object or null

getLastRunEnd

Date getLastRunEnd()

Last run (end time) of this timer.

Returns:

a date object or null