oracle.as.scheduler
Class Trigger

java.lang.Object
  oracle.as.scheduler.BaseMetadata<Trigger>
      oracle.as.scheduler.Trigger

All Implemented Interfaces:

java.io.Serializable

public class Trigger
extends BaseMetadata<Trigger>
implements java.io.Serializable

This class encapsulate the definition of a trigger for event based scheduling. Similar to the time-based scheduling that is defined by a Schedule definition, the event-based scheduling is defined by a Trigger definition. A Trigger definition defines what events the associated request depends on for execution. It also provides support for specifying event filters.

See Also:

Serialized Form

Constructor Summary

	Trigger(java.lang.String name, java.lang.String description, org.w3c.dom.Document expression, Filter[] filters) Constructs a new instance
protected	Trigger(java.lang.String name, java.lang.String description, org.w3c.dom.Document expression, Filter[] filters, MetadataObjectId objectId) INTERNAL USE ONLY Constructs a new instance
	Trigger(java.lang.String name, java.lang.String displayNameKey, java.lang.String descriptionKey, org.w3c.dom.Document expression, Filter[] filters, java.lang.String[] resourceBundleIDs) Constructs a new instance and associate resource bundles

Method Summary

Trigger	clone(java.lang.String newName)
boolean	equals(java.lang.Object obj) Compares an object for equality with this Trigger object.
static Trigger	from(javax.management.openmbean.CompositeData cd) Create an instance of the model specific class out of an associated CompositeData instance
BaseMetadataType<Trigger>	getBaseMetadataType()
Filter[]	getEventFilters() Method to retrieve list of all event filters
org.w3c.dom.Document	getExpression() Method to retrieve trigger expression xml document
protected Trigger	getSelf()
int	hashCode() Returns the hash code value of this Trigger object.
void	setEventFilters(Filter[] filters) Method to set the event filters for this Trigger.
void	setExpression(org.w3c.dom.Document expression) Method to set the trigger expression for this Trigger.
javax.management.openmbean.CompositeData	toCompositeData(javax.management.openmbean.CompositeType ct)
static javax.management.openmbean.CompositeType	toCompositeType() Returns the CompositeType that describes this model specific class
java.lang.String	toString() Returns the string representation of this Trigger object.
protected void	validateCustom() Validates this instance of Trigger.

Methods inherited from class oracle.as.scheduler.BaseMetadata

from, getDescription, getDescriptionKey, getDisplayName, getDisplayNameKey, getMessages, getMetadataObjectId, getName, getResourceBundles, localize, setDescription, setDescriptionKey, setDisplayName, setDisplayNameKey, setResourceBundles, toCompositeData, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

Trigger

public Trigger(java.lang.String name,
               java.lang.String displayNameKey,
               java.lang.String descriptionKey,
               org.w3c.dom.Document expression,
               Filter[] filters,
               java.lang.String[] resourceBundleIDs)

Constructs a new instance and associate resource bundles

Parameters:

name - - the name for the new Trigger object. The name is also used as the default display name unless otherwise specifially set.

displayNameKey - - the key of the entry in the resourcebundles to lookup the name. Optional

descriptionKey - - the key of the entry in the resourcebundles to lookup the description. Optional.

expression - the XML document fragment representing the trigger expression

filters - the list of event filters. These filters are only used to select what events are of interest to the trigger. Each filter is meant to select one event.

A filter used for this purpose can include up to one operator. That operator is assumed to be Operator.AND. The only fields supported are Event.NAME and Event.TYPE. The comparison operator between the different filters in the array is OR.

resourceBundleIDs - -- an array of resource bundle id. Optional

Trigger

public Trigger(java.lang.String name,
               java.lang.String description,
               org.w3c.dom.Document expression,
               Filter[] filters)

Constructs a new instance

Parameters:

name - - the name for the new Trigger object. The name is also used as the default display name unless otherwise specifially set.

description - - optional description to be associated with the new Trigger.

expression - the XML document fragment representing the trigger expression

filters - the list of event filters. These filters are only used to select what events are of interest to the trigger. Each filter is meant to select one event.

A filter used for this purpose can include up to one operator. That operator is assumed to be Operator.AND. The only fields supported are Event.NAME and Event.TYPE. The comparison operator between the different filters in the array is OR.

Trigger

protected Trigger(java.lang.String name,
                  java.lang.String description,
                  org.w3c.dom.Document expression,
                  Filter[] filters,
                  MetadataObjectId objectId)

INTERNAL USE ONLY Constructs a new instance

Parameters:

name - - the name for the new Trigger object. The name is also used as the default display name unless otherwise specifially set.

description - - optional description to be associated with the new Trigger.

expression - the XML document fragment representing the trigger expression

filters - the list of event filters. These filters are only used to select what events are of interest to the trigger. Each filter is meant to select one event.

A filter used for this purpose can include up to one operator. That operator is assumed to be Operator.AND. The only fields supported are Event.NAME and Event.TYPE. The comparison operator between the different filters in the array is OR.

Method Detail

getExpression

public org.w3c.dom.Document getExpression()

Method to retrieve trigger expression xml document

Returns:

- the XML document containing the trigger expression.

setExpression

public void setExpression(org.w3c.dom.Document expression)

Method to set the trigger expression for this Trigger.

Parameters:

expression - - the XML document containing the trigger expression.

getEventFilters

public Filter[] getEventFilters()

Method to retrieve list of all event filters

setEventFilters

public void setEventFilters(Filter[] filters)

Method to set the event filters for this Trigger.

Parameters:

filters - - array of filters objects corresponding do the event filters this Trigger wants.

validateCustom

protected void validateCustom()
                       throws ValidationException

Validates this instance of Trigger.

Specified by:

validateCustom in class BaseMetadata<Trigger>

Throws:

ValidationException - - thrown if any invalid data is detected.

equals

public boolean equals(java.lang.Object obj)

Compares an object for equality with this Trigger object.

Overrides:

equals in class java.lang.Object

Parameters:

obj - - the object to compare with this Trigger.

Returns:

- true if the object passed in is an instance of Trigger and is equal to this Trigger, false otherwise.

hashCode

public int hashCode()

Returns the hash code value of this Trigger object.

Overrides:

hashCode in class BaseMetadata<Trigger>

Returns:

- the hash code value of this Trigger object.

toString

public java.lang.String toString()

Returns the string representation of this Trigger object.

Overrides:

toString in class BaseMetadata<Trigger>

Returns:

- the String representation of this Trigger object.

toCompositeType

public static javax.management.openmbean.CompositeType toCompositeType()

Returns the CompositeType that describes this model specific class

toCompositeData

public javax.management.openmbean.CompositeData toCompositeData(javax.management.openmbean.CompositeType ct)

Specified by:

toCompositeData in class BaseMetadata<Trigger>

from

public static Trigger from(javax.management.openmbean.CompositeData cd)
                    throws java.lang.IllegalArgumentException

Create an instance of the model specific class out of an associated CompositeData instance

Throws:

java.lang.IllegalArgumentException

getSelf

protected Trigger getSelf()

Specified by:

getSelf in class BaseMetadata<Trigger>

getBaseMetadataType

public BaseMetadataType<Trigger> getBaseMetadataType()

Specified by:

getBaseMetadataType in class BaseMetadata<Trigger>

clone

public Trigger clone(java.lang.String newName)

Specified by:

clone in class BaseMetadata<Trigger>