Package oracle.as.scheduler

Class Exclusion

java.lang.Object
oracle.as.scheduler.Exclusion
All Implemented Interfaces:
Serializable
public class Exclusion extends Object implements Serializable
Date/time instances that are excluded from the occurrences of a Schedule.

Instance of Exclusion can be added to the ExclusionsDefinition that contains the list of such exclusion instances. One or more ExclusionsDefinition objects are then referred by the Schedule.

An example would be the list of holidays. This list of holidays can be defined as an ExclusionsDefinition object where each holiday is represented by an instance of Exclusion.

Exclusion can be created with an ExplicitDate or with an Recurrence object. The Recurrence can represent one specific date such as Thanksgiving or a recurring pattern.

See Also:

  • Constructor Details

    • Exclusion

      public Exclusion(String name, ExplicitDate date)
      Constructs a new instance representing the given explicit date. The name of an Exclusions is optional. An example where the Exclusion might be named is any specific holiday such as Independence Day.
      Parameters:
      name - optional name to be given to the Exclusion.
      date - the date this Exclusion represent.

    • Exclusion

      public Exclusion(String name, Recurrence recur)
      Constructs a new instance representing the given recurrence. The name of an Exclusions is optional. An example where the Exclusion might be named is any specific holiday such as Thanksgiving.
      Parameters:
      name - optional name to be given to the Exclusion.
      recur - the recurrence this Exclusion represent.

  • Method Details

    • getName

      public String getName()
      Gets the name of this Exclusion object.
      Returns:
      name if present, or null otherwise.

    • setName

      public void setName(String name)
      Sets the name of this Exclusion object.

    • setExplicitDate

      public void setExplicitDate(ExplicitDate date) throws UnsupportedOperationException
      Sets the explicit date of this Exclusion object.

      This method cannot be called if object already has a recurrence defined.

      Parameters:
      date - explicit date to be set for this object.
      Throws:
      UnsupportedOperationException - thrown if this object already has a recurrence set.

    • getExplicitDate

      public ExplicitDate getExplicitDate()
      Gets the explicit date this Exclusion object represents.
      Returns:
      explicit date if present, or null otherwise.

    • setRecurrence

      public void setRecurrence(Recurrence recur) throws UnsupportedOperationException
      Sets the recurrence of this Exclusion object.

      This method cannot be called if this object already contains an explicit date.

      Parameters:
      recur - the Recurrence instance to be set for this object.
      Throws:
      UnsupportedOperationException - if this object already has an explicit date set.

    • getRecurrence

      public Recurrence getRecurrence()
      Gets the recurrence of this Exclusion object.
      Returns:
      the recurrence if present, or null otherwise.

    • isExcluded

      public boolean isExcluded(Calendar start, Calendar date)
      Checks if a given date is contained in this Exclusion. If a given date is present, it indicates that the specific date must be excluded.

      The method also requires a start time if this Exclusion instance is based on Recurrence. The start time is the time from which the contained recurrence will start generating occurrences to check if the specified date is one of the occurrence or not. The method stops generating occurrence when the given date matches one of the generated occurrence or as soon as the generated occurrence goes beyond (after) the given date.

      Parameters:
      start - used as the starting point of this Exclusion is based on Recurrence. If null, the underlying Recurrence will use the current timestamp to generate occurrences.
      date - the date/time to be checked for exclusion.
      Returns:
      true if the given date must be excluded, or false otherwise.

    • validate

      public void validate() throws ValidationException
      Validates this instance of Exclusion to make sure it contains valid Recurrence or ExplicitDate. This method also gets called via ExclusionsDefinition during persistence into metadata repository.
      Throws:
      ValidationException - if any invalid data is detected.

    • equals

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

    • hashCode

      public int hashCode()
      The hash code value of this Exclusion object.
      Overrides:
      hashCode in class Object
      Returns:
      the hash code value of this Exclusion object.