com.orchestranetworks.service
Class ActionPermission

java.lang.Object
  com.orchestranetworks.service.ActionPermission

public final class ActionPermission

extends Object

Defines the permission for a user to execute or not an action. The possible states are :

• hidden – the action is not displayed to the user;
• disabled – the action existence is shown to the user but he cannot execute it; optionally a message may tells why he cannot execute it;
• enabled – the action is displayed and may be executed;

Method Summary

static Nomenclature	getActionPermissionNomenclature(Locale currentLocale)
static ActionPermission	getDisabled() Factory method that specifies that an action cannot be executed in the current session context, however the action is displayed to the user, without giving a specific reason.
static ActionPermission	getDisabled(UserMessage disabledReason) Factory method that specifies that an action cannot be executed in the current session context, however the action is displayed to the user, and the reason specified is given to the user.
UserMessage	getDisabledReason() Only defined if this state is set as 'disabled' and a specific reason is provided.
static ActionPermission	getEnabled() Factory method that specifies that an action may be executed in the current session context.
char	getFlag() Persistent flag that identifies the permission.
static ActionPermission	getHidden() Factory method that specifies that an action cannot be executed in the current session context and the action is not displayed to the user.
static Nomenclature	getReadOnlyActionPermissionNomenclature(Locale currentLocale)
boolean	isDisabled()
boolean	isDisabledOrHidden() This method returns the opposite of isEnabled().
boolean	isEnabled()
boolean	isHidden()
boolean	isSameFlag(String aFlagString) Returns true if the flag specified is the same as the flag of this permission.
static ActionPermission	parseFlag(char accessFlag)
static ActionPermission	parseFlag(String actionFlag)
String	toDisplayString(Locale aLocale)
static String	toDisplayString(Locale aLocale, char aFlag) Deprecated.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getEnabled

public static ActionPermission getEnabled()

Factory method that specifies that an action may be executed in the current session context.

getDisabled

public static ActionPermission getDisabled()

Factory method that specifies that an action cannot be executed in the current session context, however the action is displayed to the user, without giving a specific reason.

getDisabled

public static ActionPermission getDisabled(UserMessage disabledReason)

Factory method that specifies that an action cannot be executed in the current session context, however the action is displayed to the user, and the reason specified is given to the user.

getHidden

public static ActionPermission getHidden()

Factory method that specifies that an action cannot be executed in the current session context and the action is not displayed to the user.

toString

public String toString()

isEnabled

public boolean isEnabled()

See Also:

getEnabled()

isDisabled

public boolean isDisabled()

See Also:

getDisabled(), getDisabled(UserMessage)

isHidden

public boolean isHidden()

See Also:

getHidden()

isDisabledOrHidden

public boolean isDisabledOrHidden()

This method returns the opposite of isEnabled().

getDisabledReason

public UserMessage getDisabledReason()

Only defined if this state is set as 'disabled' and a specific reason is provided.

See Also:

getDisabled(UserMessage)

parseFlag

public static ActionPermission parseFlag(String actionFlag)

parseFlag

public static ActionPermission parseFlag(char accessFlag)

getFlag

public char getFlag()

Persistent flag that identifies the permission.

isSameFlag

public boolean isSameFlag(String aFlagString)

Returns true if the flag specified is the same as the flag of this permission.

getActionPermissionNomenclature

public static Nomenclature getActionPermissionNomenclature(Locale currentLocale)

toDisplayString

public String toDisplayString(Locale aLocale)

toDisplayString

public static String toDisplayString(Locale aLocale,
                                     char aFlag)

Deprecated.

See Also:

toDisplayString(Locale)

getReadOnlyActionPermissionNomenclature

public static Nomenclature getReadOnlyActionPermissionNomenclature(Locale currentLocale)