com.github.dynamicextensionsalfresco.behaviours.annotations

Enum Event

java.lang.Object

java.lang.Enum<Event>

com.github.dynamicextensionsalfresco.behaviours.annotations.Event

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Event>

public enum Event
extends java.lang.Enum<Event>

Indicates the event at an annotation-based Behaviour should be triggered.

This enum maps directly to the Behaviour.NotificationFrequency used to register Behaviours.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL Indicates the Behaviour should be triggered at every event.
COMMIT Indicates the Behaviour should be triggered at the end, at the commit of the transaction.
FIRST Indicates the Behaviour should be triggered only at the start.
INHERITED_OR_ALL Indicates that the value should be inherited or default to ALL.

Method Summary

Modifier and Type	Method and Description
org.alfresco.repo.policy.Behaviour.NotificationFrequency	toNotificationFrequency()
static Event	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Event[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FIRST

public static final Event FIRST

Indicates the Behaviour should be triggered only at the start.

See Also:

Behaviour.NotificationFrequency.FIRST_EVENT

ALL

public static final Event ALL

Indicates the Behaviour should be triggered at every event. In practice, this means the Behaviour is triggered at the start and at the commit. (I.e. the start and transaction commit are the only events.)

See Also:

Behaviour.NotificationFrequency.EVERY_EVENT

COMMIT

public static final Event COMMIT

Indicates the Behaviour should be triggered at the end, at the commit of the transaction.

See Also:

Behaviour.NotificationFrequency.TRANSACTION_COMMIT

INHERITED_OR_ALL

public static final Event INHERITED_OR_ALL

Indicates that the value should be inherited or default to ALL. This effectively acts as a "null" value for the ClassPolicy.event(), AssociationPolicy.event() and PropertyPolicy.event().

Method Detail

values

public static Event[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Event c : Event.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Event valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

toNotificationFrequency

public org.alfresco.repo.policy.Behaviour.NotificationFrequency toNotificationFrequency()