Package org.cyclos.model.system.extensionpoints

Enum UserExtensionPointEvent

java.lang.Object

java.lang.Enum<UserExtensionPointEvent>

org.cyclos.model.system.extensionpoints.UserExtensionPointEvent

All Implemented Interfaces:

Serializable, Comparable<UserExtensionPointEvent>, ExtensionPointEvent, HasMessageKey

public enum UserExtensionPointEvent
extends Enum<UserExtensionPointEvent>
implements ExtensionPointEvent, HasMessageKey

Possible events to be handled by user extension points

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACTIVATE
CHANGE_GROUP
CHANGE_STATUS
CREATE
UPDATE

Field Summary

Fields

Modifier and Type	Field	Description
static String	ATTR_COMMENTS	Scripting attribute: the comments on a group / status change
static String	ATTR_NEW_GROUP	Scripting attribute: the new user group
static String	ATTR_NEW_STATUS	Scripting attribute: the new user status
static String	ATTR_OLD_GROUP	Scripting attribute: the old user group
static String	ATTR_OLD_STATUS	Scripting attribute: the old user status
static String	ATTR_USER	Scripting attribute: the user being affected

Method Summary

Modifier and Type	Method	Description
MessageKey	getMessageKey()
ExtensionPointNature	nature()	Returns the nature of this set of events
static UserExtensionPointEvent	valueOf(String name)	Returns the enum constant of this type with the specified name.
static UserExtensionPointEvent[]	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

Methods inherited from interface org.cyclos.model.system.extensionpoints.ExtensionPointEvent

name

Enum Constant Detail

CREATE

public static final UserExtensionPointEvent CREATE

ACTIVATE

public static final UserExtensionPointEvent ACTIVATE

UPDATE

public static final UserExtensionPointEvent UPDATE

CHANGE_GROUP

public static final UserExtensionPointEvent CHANGE_GROUP

CHANGE_STATUS

public static final UserExtensionPointEvent CHANGE_STATUS

Field Detail

ATTR_USER

public static final String ATTR_USER

Scripting attribute: the user being affected

See Also:

Constant Field Values

ATTR_OLD_STATUS

public static final String ATTR_OLD_STATUS

Scripting attribute: the old user status

See Also:

Constant Field Values

ATTR_NEW_STATUS

public static final String ATTR_NEW_STATUS

Scripting attribute: the new user status

See Also:

Constant Field Values

ATTR_OLD_GROUP

public static final String ATTR_OLD_GROUP

Scripting attribute: the old user group

See Also:

Constant Field Values

ATTR_NEW_GROUP

public static final String ATTR_NEW_GROUP

Scripting attribute: the new user group

See Also:

Constant Field Values

ATTR_COMMENTS

public static final String ATTR_COMMENTS

Scripting attribute: the comments on a group / status change

See Also:

Constant Field Values

Method Detail

values

public static UserExtensionPointEvent[] 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 (UserExtensionPointEvent c : UserExtensionPointEvent.values())
    System.out.println(c);

Returns:

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

valueOf

public static UserExtensionPointEvent valueOf(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:

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

NullPointerException - if the argument is null

getMessageKey

public MessageKey getMessageKey()

Specified by:

getMessageKey in interface HasMessageKey

nature

public ExtensionPointNature nature()

Description copied from interface: ExtensionPointEvent

Returns the nature of this set of events

Specified by:

nature in interface ExtensionPointEvent