org.alfresco.service.cmr.action.scheduled

Interface SchedulableAction

All Known Subinterfaces:

QuickShareLinkExpiryAction, ReplicationDefinition, ScheduledPersistedAction

All Known Implementing Classes:

QuickShareLinkExpiryActionImpl, ReplicationDefinitionImpl, ScheduledPersistedActionImpl

public interface SchedulableAction

The scheduling details for an action, normally used via ScheduledPersistedAction

Since:

3.4

Author:

Nick Burch

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SchedulableAction.IntervalPeriod

Method Summary

Modifier and Type	Method and Description
Integer	getScheduleIntervalCount() How many getScheduleIntervalPeriod() periods should we wait between executions? Will be null if the action isn't scheduled to be repeated.
SchedulableAction.IntervalPeriod	getScheduleIntervalPeriod() How long are getScheduleIntervalCount() counts measured in?
Date	getScheduleStart() Get the first date that the action should be run on or after, or null if it should start shortly after each startup.
void	setScheduleIntervalCount(Integer count) Sets how many periods should be waited between each execution, or null if it shouldn't be repeated.
void	setScheduleIntervalPeriod(SchedulableAction.IntervalPeriod period) Sets the interval period
void	setScheduleStart(Date startDate) Sets the first date that the action should be run on or after.

Method Detail

getScheduleStart

Date getScheduleStart()

Get the first date that the action should be run on or after, or null if it should start shortly after each startup.

setScheduleStart

void setScheduleStart(Date startDate)

Sets the first date that the action should be run on or after. Set to null if the action should be run shortly after each startup.

getScheduleIntervalCount

Integer getScheduleIntervalCount()

How many getScheduleIntervalPeriod() periods should we wait between executions? Will be null if the action isn't scheduled to be repeated.

setScheduleIntervalCount

void setScheduleIntervalCount(Integer count)

Sets how many periods should be waited between each execution, or null if it shouldn't be repeated.

getScheduleIntervalPeriod

SchedulableAction.IntervalPeriod getScheduleIntervalPeriod()

How long are getScheduleIntervalCount() counts measured in?

setScheduleIntervalPeriod

void setScheduleIntervalPeriod(SchedulableAction.IntervalPeriod period)

Sets the interval period