Package oracle.as.scheduler

Class Schedule

java.lang.Object
oracle.as.scheduler.BaseMetadata<Schedule>
oracle.as.scheduler.Schedule
All Implemented Interfaces:
Serializable
public class Schedule extends BaseMetadata<Schedule> implements Serializable
Used to specify time-based recurrence.

The core part of the Schedule is the Recurrence class that provides occurrence based on the defined recurrence pattern. Schedule allows adding dates to be explicitly included for generating occurrences in addition to the one generated by the recurrence pattern.

Note that more than one Recurrence can also be supplied with a Schedule with the help of RecurrenceSet class. The resulting occurrences for the schedule would be the union of occurrences generated by the individual recurrences present in RecurrenceSet.

It is also possible to exclude date/times instances from the list of occurrences a Schedule generates. Such exclusions can be specified in two mode, by explicitly providing a list of dates to an instance of Schedule or by referencing to a named ExclusionsDefinition. An example would be an ExclusionsDefinition that contains the list of holidays for which the Schedule must skip the occurrences if generated.

The start and end date/times if specified in the contained Recurrence only apply to the occurrences generated by the recurrence pattern. Any additional dates explicitly added to the Schedule can fall before the start or after the end date specified.

Example
Schedule to run every monday at 10:00 am plus on 10th of July 2006, but exclude the 15th May 2006. 

 Recurrence recur = new Recurrence(RecurrenceFields.FREQUENCY.WEEKLY);
 recur.addDayOfWeek(RecurrenceFields.DAY_OF_WEEK.MONDAY);
 recur.setRecurTime(RecurrenceFields.TIME_OF_DAY.valueOf(10, 0, 0));

 ExplicitDate july10 = new ExplicitDate(RecurrenceFields.YEAR.valueOf(2006),
                                        RecurrenceFields.MONTH_OF_YEAR.JULY
                                        RecurrenceFields.DAY_OF_MONTH.valueOf(10));

 ExplicitDate may15 = new ExplicitDate(RecurrenceFields.YEAR.valueOf(2006),
                                       RecurrenceFields.MONTH_OF_YEAR.MAY,
                                       RecurrenceFields.DAY_OF_MONTH.valueOf(15));

 Schedule schedule = new Schedule("everyMonday", "Weekly Schedule", recur);
 schedule.addInclusionDate(july10);
 schedule.addExclusionDate(may15);

See Also:

  • Field Details

    • DEFAULT_LIST_LIMIT

      public static final int DEFAULT_LIST_LIMIT
      Maximum size of the list of occurences returned by schedule. Initialized to 300.
      See Also:

  • Constructor Details

    • Schedule

      public Schedule(String name, String description, Recurrence recur)
      Constructs a new instance with the given recurrence.
      Parameters:
      name - name of the new instance. It cannot be null. The name is also used as the default display name unless otherwise specifically set.
      description - an optional description.
      recur - an instance of Recurrence object

    • Schedule

      public Schedule(String name, String displayNameKey, String descriptionKey, Recurrence recur, String[] resourceBundleIDs)
      Constructs a new instance with the given recurrence and associate resource bundles.
      Parameters:
      name - name of the new instance. It cannot be null. The name is also used as the default display name unless otherwise specifically set.
      displayNameKey - the resource bundle key for the display name. Optional.
      descriptionKey - the resource bundle key for the description. Optional.
      recur - an instance of Recurrence object
      resourceBundleIDs - an array of resource bundle id. Optional.

    • Schedule

      public Schedule(String name, String description, RecurrenceSet recurSet)
      Constructs a new instance with the given RecurrenceSet.
      Parameters:
      name - name of the new instance. It cannot be null. The name is also used as the default display name unless otherwise specifically set.
      description - an optional description.
      recurSet - an instance of RecurrenceSet object

    • Schedule

      public Schedule(String name, String displayNameKey, String descriptionKey, RecurrenceSet recurSet, String[] resourceBundleIDs)
      Constructs a new instance with the given RecurrenceSet and associate resource bundles.
      Parameters:
      name - name of the new instance. It cannot be null. The name is also used as the default display name unless otherwise specifically set.
      displayNameKey - the resource bundle key for the display name. Optional.
      descriptionKey - the resource bundle key for the description. Optional.
      recurSet - an instance of RecurrenceSet object
      resourceBundleIDs - an array of resource bundle id. Optional.

    • Schedule

      public Schedule(String name, String description, Collection<ExplicitDate> dates)
      Constructs a new instance with the given set of explicit dates.
      Parameters:
      name - the name for the new instance. It cannot be null. The name is also used as the default display name unless otherwise specifically set.
      description - an optional description.
      dates - a collection explicit dates for occurrences.

    • Schedule

      public Schedule(String name, String displayNameKey, String descriptionKey, Collection<ExplicitDate> dates, String[] resourceBundleIDs)
      Constructs a new instance with the given set of explicit dates and associate resource bundles.
      Parameters:
      name - name of the new instance. It cannot be null. The name is also used as the default display name unless otherwise specifically set.
      displayNameKey - the resource bundle key for the display name. Optional.
      descriptionKey - the resource bundle key for the description. Optional.
      dates - a collection explicit dates for occurrences.
      resourceBundleIDs - an array of resource bundle id.

  • Method Details

    • getRecurrence

      public Recurrence getRecurrence()
      Gets the recurrence object of this schedule instance.
      Returns:
      recurrence of this Schedule instance.

    • setRecurrence

      public void setRecurrence(Recurrence recur)
      Sets the recurrence for this schedule instance.
      Parameters:
      recur - Recurrence object that should be used by this Schedule instance.

    • getRecurrenceSet

      public RecurrenceSet getRecurrenceSet()
      Gets the RecurrenceSet object of this schedule instance.
      Returns:
      RecurrenceSet of this object.

    • setRecurrenceSet

      public void setRecurrenceSet(RecurrenceSet recurSet)
      Sets the RecurrenceSet for this schedule instance.
      Parameters:
      recurSet - RecurrenceSet object that should be used.

    • addInclusionDate

      public void addInclusionDate(ExplicitDate date)
      Adds an explicit date to be included for occurrences in this Schedule object.
      Parameters:
      date - the explicit date to be included.

    • removeInclusionDate

      public void removeInclusionDate(ExplicitDate date)
      Removes an explicit date from list of included dates of this Schedule object.
      Parameters:
      date - the explicit date to be removed from the list of included dates.

    • setInclusionDates

      public void setInclusionDates(Collection<ExplicitDate> dates)
      Sets the list of dates to be included for occurrences in this Schedule.
      Parameters:
      dates - collection of explicit date to be included.

    • getInclusionDates

      public Collection<ExplicitDate> getInclusionDates()
      Gets the list of explicit dates that are included for occurrences in this Schedule object.
      Returns:
      collection of explicit dates that are included for occurrences in this object.

    • addExclusionDate

      public void addExclusionDate(ExplicitDate date)
      Adds an explicit date to be excluded from occurrences in this Schedule object.
      Parameters:
      date - the explicit date to be excluded.

    • removeExclusionDate

      public void removeExclusionDate(ExplicitDate date)
      Removes an explicit date from the list of dates excluded for occurrences in this Schedule object.
      Parameters:
      date - the explicit date to be removed from the list of excluded dates.

    • setExclusionDates

      public void setExclusionDates(Collection<ExplicitDate> dates)
      Sets the list of dates excluded for occurrences in this Schedule object.
      Parameters:
      dates - the list of explicit date to be excluded.

    • getExclusionDates

      public Collection<ExplicitDate> getExclusionDates()
      Gets the list of dates excluded for occurrences in this Schedule object.
      Returns:
      list of explicit date excluded for occurrences in this object.

    • addExclusion

      public void addExclusion(MetadataObjectId objectId)
      Adds a reference of an instance of ExclusionsDefinition in this Schedule object.
      Parameters:
      objectId - the identifier of the ExclusionsDefinition to be added.

    • removeExclusion

      public void removeExclusion(MetadataObjectId objectId)
      Removes the given reference of ExclusionsDefinition from this Schedule object.
      Parameters:
      objectId - identifier of the ExclusionsDefinition to be removed.

    • getExclusions

      public Collection<MetadataObjectId> getExclusions()
      Gets the list of ExclusionsDefinition metadata ids that are referenced by this object.
      Returns:
      the list of identifiers for the ExclusionsDefinition object referred by this object.

    • getTimeZone

      public TimeZone getTimeZone()
      Gets the TimeZone set for this Schedule object. If a Schedule object has as TimeZone set, it operates with respect to the set TimeZone. Otherwise the Schedule is TimeZone agnostic.
      Returns:
      TimeZone set in this Schedule object. Null otherwise.

    • setTimeZone

      public void setTimeZone(TimeZone tz)
      Sets or clears the TimeZone for this Schedule object. A null TimeZone make the Schedule time zone agnostic.
      Parameters:
      tz - the TimeZone to be set for this object. NULL if the TimeZone needs to be cleared/unset.

    • list

      public Collection<Calendar> list(Calendar begin, Calendar end) throws IllegalArgumentException
      Generates a list of possible occurrences of this Schedule object within a given time period up to the default limit of 300.
      Parameters:
      begin - the start date/time for listing possible occurrences, inclusive, not null.
      end - the end date/time for listing possible occurrences, inclusive, not null.
      Returns:
      a collection of Calendar instances representing possible occurrences. null if no occurrences are possible in the given time period. The maximum number of results are limited by the property DEFAULT_LIST_LIMIT of 300 occurrences.
      Throws:
      IllegalArgumentException

    • list

      public Collection<Calendar> list(Calendar begin, int count) throws IllegalArgumentException
      Generates a list of possible occurrences of this Schedule object starting with the given time up to the specified count.
      Parameters:
      begin - the start date/time for listing occurrences, inclusive, not null.
      count - the maximum number of occurrences to be listed.
      Returns:
      a collection of Calendar instances representing possible occurrences up to the specified count, or null if no occurrences are possible.
      Throws:
      IllegalArgumentException

    • list

      public Collection<Calendar> list(Calendar begin, Calendar end, int limit) throws IllegalArgumentException
      Generates a list of possible occurrences of this Schedule object within a given time period.
      Parameters:
      begin - the start date/time for listing possible occurrences, inclusive, not null.
      end - the end date/time for listing possible occurrences, inclusive.
      limit - the maximum number of occurrences to be listed. The limit has to be a positive integer or zero. A zero limit results an empty list.
      Returns:
      a collection of Calendar instances representing possible occurrences up to the specified limit. This will be null if no occurrences are possible in the given time period.
      Throws:
      IllegalArgumentException

    • equals

      public boolean equals(Object obj)
      Compares an object for equality with this Schedule object.
      Overrides:
      equals in class Object
      Parameters:
      obj - the object to compare with this Schedule.
      Returns:
      true if the object passed in is an instance of Schedule and is equal to this Schedule, false otherwise.

    • toString

      public String toString()
      Gets a String representation for this Schedule object.
      Overrides:
      toString in class BaseMetadata<Schedule>
      Returns:
      a String representing this Schedule.

    • getBaseMetadataType

      public BaseMetadataType<Schedule> getBaseMetadataType()
      Description copied from class: BaseMetadata
      Gets the intended type of this metadata.
      Specified by:
      getBaseMetadataType in class BaseMetadata<Schedule>
      Returns:
      the base metadata type

    • clone

      public Schedule clone(String newName)
      Specified by:
      clone in class BaseMetadata<Schedule>

    • toDisplayString

      public String toDisplayString(Locale locale)
      Enterprise Manager support to acquire a localized string value.
      Parameters:
      locale - the desired locale
      Returns:
      a localized string describing this schedule.