org.cyclos.model.system.operations

Enum CustomOperationScope

java.lang.Object

java.lang.Enum<CustomOperationScope>

org.cyclos.model.system.operations.CustomOperationScope

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CustomOperationScope>, HasMessageKey

public enum CustomOperationScope
extends java.lang.Enum<CustomOperationScope>
implements HasMessageKey

Determines the scope of a custom operation

Author:

luis

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADVERTISEMENT A custom operation which can be executed from an advertisement
BULK_ACTION A custom operation to be executed as a bulk action over a set of users
INTERNAL A custom operation which is executed by another custom operation
MENU A custom operation which is visible in a custom menu item
RECORD A custom operation which can be executed from a record
SYSTEM A general, system custom operation
USER A custom operation over a single user

Method Summary

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

SYSTEM

public static final CustomOperationScope SYSTEM

A general, system custom operation

USER

public static final CustomOperationScope USER

A custom operation over a single user

BULK_ACTION

public static final CustomOperationScope BULK_ACTION

A custom operation to be executed as a bulk action over a set of users

MENU

public static final CustomOperationScope MENU

A custom operation which is visible in a custom menu item

INTERNAL

public static final CustomOperationScope INTERNAL

A custom operation which is executed by another custom operation

ADVERTISEMENT

public static final CustomOperationScope ADVERTISEMENT

A custom operation which can be executed from an advertisement

RECORD

public static final CustomOperationScope RECORD

A custom operation which can be executed from a record

Method Detail

values

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

Returns:

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

valueOf

public static CustomOperationScope 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

getMessageKey

public MessageKey getMessageKey()

Specified by:

getMessageKey in interface HasMessageKey