org.nuxeo.ecm.core.scheduler

Interface Schedule

All Superinterfaces:

Serializable

All Known Implementing Classes:

ScheduleImpl

public interface Schedule
extends Serializable

Schedule entry.

Holds information about a schedule, including the event to send, the username to use to open the session, and the periodicity for the schedule.

Method Summary

Modifier and Type	Method and Description
String	getCronExpression() Returns the cron expression.
String	getEventCategory() Returns the event category.
String	getEventId() Returns the event id.
String	getId() Returns the schedule job id.
EventJobFactory	getJobFactory() Returns an instance of the EventJobFactory (DefaultEventJobFactory by default).
String	getTimeZone() Returns the timezone to be used for the Cron Expression.
String	getUsername() Returns the username.
boolean	isEnabled() Returns true if the scheduler is enabled and the job scheduled for execution

Method Detail

getId

String getId()

Returns the schedule job id.

Returns:

the schedule job id.

getJobFactory

EventJobFactory getJobFactory()

Returns an instance of the EventJobFactory (DefaultEventJobFactory by default).

Returns:

An instance of EventJobFactory.

Since:

10.2

getEventId

String getEventId()

Returns the event id.

Returns:

the event id

getEventCategory

String getEventCategory()

Returns the event category.

Returns:

the event category

getCronExpression

String getCronExpression()

Returns the cron expression.

Returns:

the cron expression

getUsername

String getUsername()

Returns the username.

Returns:

the username

isEnabled

boolean isEnabled()

Returns true if the scheduler is enabled and the job scheduled for execution

Returns:

Since:

5.7.3

getTimeZone

String getTimeZone()

Returns the timezone to be used for the Cron Expression.

Returns:

the timezone, or null if not specified

Since:

10.2