oracle.as.scheduler

Class ExclusionsDefinition

java.lang.Object

oracle.as.scheduler.BaseMetadata

oracle.as.scheduler.ExclusionsDefinition

All Implemented Interfaces:

Serializable

public class ExclusionsDefinition
extends BaseMetadata
implements Serializable

Used to represent a collection of Exclusion objects as a single unit.

Instances of ExclusionsDefinition are persisted in the metadata repository which makes it a sharable object across Schedule definitions.

An example is list of holidays represented as one instance of an ExclusionsDefinition object that contains all the individual holidays represented by instances of Exclusion class. A Schedule then refer to this holidays to skip any occurrences that happen on any of these holidays.

See Also:

Exclusion, Schedule, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ExclusionsDefinition(String name, String description, Collection exclusions) Constructs a new instance with the given collection of exclusions.
ExclusionsDefinition(String name, String displayNameKey, String descriptionKey, Collection exclusions, String[] resourceBundleIDs) Constructs a new instance with the given collection of exclusions.

Method Summary

Methods

Modifier and Type	Method and Description
void	addExclusion(Exclusion exclusion) Add an exclusion to this object.
ExclusionsDefinition	clone(String newName)
boolean	equals(Object obj) Compares an object for equality with this ExclusionsDefinition object.
BaseMetadataType	getBaseMetadataType() Gets the intended type of this metadata.
Collection	getExclusions() Gets the list of exclusions of this object.
boolean	isExcluded(Calendar start, Calendar date) Check if a given date fall in the list of exclusions contained within this ExclusionsDefinition instance.
void	removeExclusion(Exclusion exclusion) Removes an Exclusion from this ExclusionsDefinition object.
void	setExclusions(Collection exclusions) Sets the list of exclusions of this object.

Methods inherited from class oracle.as.scheduler.BaseMetadata

getDescription, getDescriptionKey, getDisplayName, getDisplayNameKey, getMetadataObjectId, getName, getResourceBundles, hashCode, setDescription, setDescriptionKey, setDisplayName, setDisplayNameKey, setResourceBundles, toString, validate

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ExclusionsDefinition

public ExclusionsDefinition(String name,
                    String description,
                    Collection exclusions)

Constructs a new instance with the given collection of exclusions.

Parameters:

name - the name for this instance. It cannot be null. The name is also used as the default display name.

description - an optional description string.

exclusions - collection of exclusions instances for the new instance.

ExclusionsDefinition

public ExclusionsDefinition(String name,
                    String displayNameKey,
                    String descriptionKey,
                    Collection exclusions,
                    String[] resourceBundleIDs)

Constructs a new instance with the given collection of exclusions.

Parameters:

name - the bame for this 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.

exclusions - collection of exclusions instances for the new instance.

resourceBundleIDs - an array of resource bundle ids. This is optional.

Method Detail

addExclusion

public void addExclusion(Exclusion exclusion)

Add an exclusion to this object.

Parameters:

exclusion - instance of Exclusion to be added to this object.

removeExclusion

public void removeExclusion(Exclusion exclusion)

Removes an Exclusion from this ExclusionsDefinition object.

Parameters:

exclusion - the Exclusion instance to be removed from the exclusions contained in this object.

getExclusions

public Collection getExclusions()

Gets the list of exclusions of this object.

Returns:

a collection containing the list of exclusions of this object.

setExclusions

public void setExclusions(Collection exclusions)

Sets the list of exclusions of this object.

Parameters:

exclusions - a collection containing the list of exclusions to be set for this object.

isExcluded

public boolean isExcluded(Calendar start,
                 Calendar date)

Check if a given date fall in the list of exclusions contained within this ExclusionsDefinition instance. If found, it indicates that the given date must be skipped or excluded.

The method takes a starting time as an argument that is used to generate occurrence if any of the Exclusion contained in this object is based on Recurrence.

Parameters:

start - the start time for any recurrence based Exclusion.

date - the date to be checked for exclusion.

Returns:

true of the given date must be excluded, or false otherwise.

equals

public boolean equals(Object obj)

Compares an object for equality with this ExclusionsDefinition object.

Overrides:

equals in class Object

Parameters:

obj - the object to compare with this ExclusionsDefinition.

Returns:

true if obj is an instanceof ExclusionsDefinition and is equal to this ExclusionsDefinition, or false otherwise.

getBaseMetadataType

public BaseMetadataType getBaseMetadataType()

Description copied from class: BaseMetadata

Gets the intended type of this metadata.

Specified by:

getBaseMetadataType in class BaseMetadata

Returns:

the base metadata type

clone

public ExclusionsDefinition clone(String newName)

Specified by:

clone in class BaseMetadata