Package com.exedio.cope.pattern

Class Schedule

java.lang.Object

com.exedio.cope.Feature

com.exedio.cope.Pattern

com.exedio.cope.pattern.Schedule

All Implemented Interfaces:

Serializable

public final class Schedule
extends Pattern

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Schedule.Interval
static class	Schedule.Run

Constructor Summary

Constructors

Constructor	Description
Schedule()	Deprecated. Use Schedule(TimeZone,Locale) instead.
Schedule(ZoneId zoneId)
Schedule(Locale locale)	Deprecated. Use Schedule(TimeZone,Locale) instead.
Schedule(TimeZone timeZone, Locale locale)	Deprecated. Use Schedule(ZoneId) instead

Method Summary

Modifier and Type	Method	Description
BooleanField	getEnabled()
EnumField<Schedule.Interval>	getInterval()
Schedule.Interval	getInterval(Item item)
Locale	getLocale()	Deprecated. Supported only if constructed by Schedule(TimeZone, Locale).
LongField	getRunElapsed()
DateField	getRunFrom()
EnumField<Schedule.Interval>	getRunInterval()
ItemField<?>	getRunParent()
<P extends Item> ItemField<P>	getRunParent(Class<P> parentClass)
IntegerField	getRunProgress()
DateField	getRunRun()
PartOf<?>	getRunRuns()
Type<Schedule.Run>	getRunType()
DateField	getRunUntil()
TimeZone	getTimeZone()
ZoneId	getZoneId()
boolean	isEnabled(Item item)
GregorianCalendar	newGregorianCalendar()	Deprecated. Supported only if constructed by Schedule(TimeZone, Locale).
void	onMount()	Here you can do additional initialization not yet done in the constructor.
<P extends Item & Scheduleable> int	run(Class<P> parentClass, Interrupter interrupter)	Deprecated. Use run(Class,JobContext) instead.
<P extends Item & Scheduleable> void	run(Class<P> parentClass, JobContext ctx)
void	setEnabled(Item item, boolean enabled)
void	setInterval(Item item, Schedule.Interval interval)

Methods inherited from class com.exedio.cope.Pattern

addSource, addSource, addSource, addSource, addSourceFeature, addSourceFeature, addSourceFeature, annotationField, equals, getGeneratedTypes, getSourceFeatures, getSourceFeaturesGather, getSourceFields, getSources, getSourceTypes, getType, hashCode, initialize, newSourceType, newSourceType, newSourceType, newSourceType, newSourceType, newSourceType, newType, newType, registerSource

Methods inherited from class com.exedio.cope.Feature

afterModelCreated, getAbstractType, getAnnotation, getID, getLocalizationKeys, getName, getPattern, isAnnotationPresent, isSourceAlready, mount, readResolve, requireMounted, toString, toString, writeReplace

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Schedule

public Schedule(ZoneId zoneId)

Schedule

@Deprecated
public Schedule(TimeZone timeZone,
                Locale locale)

Deprecated.

Use Schedule(ZoneId) instead

Parameters:

locale - specifies the locale used for creating the GregorianCalendar that does all the date computations. Is important for specifying the first day of week (Monday vs. Sunday)

Schedule

@Deprecated
public Schedule()

Deprecated.

Use Schedule(TimeZone,Locale) instead.

Schedule

@Deprecated
public Schedule(Locale locale)

Deprecated.

Use Schedule(TimeZone,Locale) instead.

Method Detail

getZoneId

public ZoneId getZoneId()

getTimeZone

public TimeZone getTimeZone()

onMount

public void onMount()

Description copied from class: Pattern

Here you can do additional initialization not yet done in the constructor. In this method you can call methods Pattern.getType() and Feature.getName() for the first time.

Overrides:

onMount in class Pattern

getEnabled

public BooleanField getEnabled()

getInterval

public EnumField<Schedule.Interval> getInterval()

getRunParent

@Nonnull
public <P extends Item> ItemField<P> getRunParent(@Nonnull
                                                  Class<P> parentClass)

getRunParent

public ItemField<?> getRunParent()

getRunInterval

public EnumField<Schedule.Interval> getRunInterval()

getRunRuns

public PartOf<?> getRunRuns()

getRunFrom

public DateField getRunFrom()

getRunUntil

public DateField getRunUntil()

getRunRun

public DateField getRunRun()

getRunProgress

public IntegerField getRunProgress()

getRunElapsed

public LongField getRunElapsed()

getRunType

public Type<Schedule.Run> getRunType()

isEnabled

public boolean isEnabled(@Nonnull
                         Item item)

setEnabled

public void setEnabled(@Nonnull
                       Item item,
                       boolean enabled)

getInterval

@Nonnull
public Schedule.Interval getInterval(@Nonnull
                                     Item item)

setInterval

public void setInterval(@Nonnull
                        Item item,
                        @Nonnull
                        Schedule.Interval interval)

run

public <P extends Item & Scheduleable> void run(@Nonnull
                                                Class<P> parentClass,
                                                @Nonnull
                                                JobContext ctx)

getLocale

@Deprecated
public Locale getLocale()

Deprecated.

Supported only if constructed by Schedule(TimeZone, Locale).

Throws:

IllegalStateException - if not supported

newGregorianCalendar

@Deprecated
public GregorianCalendar newGregorianCalendar()

Deprecated.

Supported only if constructed by Schedule(TimeZone, Locale).

Throws:

IllegalStateException - if not supported

run

@Deprecated
public <P extends Item & Scheduleable> int run(@Nonnull
                                               Class<P> parentClass,
                                               @Nullable
                                               Interrupter interrupter)

Deprecated.

Use run(Class,JobContext) instead.