com.liferay.sharing.security.permission

Enum SharingEntryAction

java.lang.Object

java.lang.Enum<SharingEntryAction>

com.liferay.sharing.security.permission.SharingEntryAction

All Implemented Interfaces:

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

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

Provides the actions that users can perform on resources shared with them. Each sharing entry action is composed of an ID and a bitwise value used to check permissions.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADD_DISCUSSION
UPDATE
VIEW

Method Summary

Modifier and Type	Method and Description
java.lang.String	getActionId() Returns the sharing entry action's ID.
long	getBitwiseValue() Returns the sharing entry action's bitwise value.
static java.util.Collection<SharingEntryAction>	getSharingEntryActions(long bitwiseValue) Returns the sharing entry actions from the bitwise value.
static boolean	isSupportedActionId(java.lang.String actionId) Returns true if the sharing entry action's ID matches a valid sharing entry action.
static SharingEntryAction	parseFromActionId(java.lang.String actionId) Returns the sharing entry action parsed from a sharing entry action's ID.
static SharingEntryAction	parseFromBitwiseValue(long bitwiseValue) Returns the sharing entry action parsed from the bitwise value.
static SharingEntryAction	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SharingEntryAction[]	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

ADD_DISCUSSION

public static final SharingEntryAction ADD_DISCUSSION

UPDATE

public static final SharingEntryAction UPDATE

VIEW

public static final SharingEntryAction VIEW

Method Detail

values

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

Returns:

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

valueOf

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

getSharingEntryActions

public static java.util.Collection<SharingEntryAction> getSharingEntryActions(long bitwiseValue)

Returns the sharing entry actions from the bitwise value.

Parameters:

bitwiseValue - the bitwise value

Returns:

the sharing entry actions

isSupportedActionId

public static boolean isSupportedActionId(java.lang.String actionId)

Returns true if the sharing entry action's ID matches a valid sharing entry action.

Parameters:

actionId - the sharing entry action's ID

Returns:

true if the sharing entry action's ID matches a valid sharing entry action; false otherwise

parseFromActionId

public static SharingEntryAction parseFromActionId(java.lang.String actionId)

Returns the sharing entry action parsed from a sharing entry action's ID.

Parameters:

actionId - the sharing entry action's ID

Returns:

the sharing entry action

parseFromBitwiseValue

public static SharingEntryAction parseFromBitwiseValue(long bitwiseValue)

Returns the sharing entry action parsed from the bitwise value.

Parameters:

bitwiseValue - the bitwise value

Returns:

the sharing entry action

getActionId

public java.lang.String getActionId()

Returns the sharing entry action's ID.

Returns:

the sharing entry action's ID

getBitwiseValue

public long getBitwiseValue()

Returns the sharing entry action's bitwise value.

Returns:

the bitwise value