Package org.nuxeo.ecm.core.scheduler
Interface Schedule
- All Known Implementing Classes:
ScheduleImpl
public interface Schedule
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 TypeMethodDescriptionReturns the cron expression.Returns the event category.Returns the event id.getId()
Returns the schedule job id.Returns an instance of theEventJobFactory
(DefaultEventJobFactory
by default).Returns the timezone to be used for the Cron Expression.Returns the username.boolean
Returns true if the scheduler is enabled and the job scheduled for execution
-
Method Details
-
getId
String getId()Returns the schedule job id.- Returns:
- the schedule job id.
-
getJobFactory
EventJobFactory getJobFactory()Returns an instance of theEventJobFactory
(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- 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
-