Enum Class SharingEntryAction

java.lang.Object
java.lang.Enum<SharingEntryAction>
com.liferay.sharing.security.permission.SharingEntryAction
All Implemented Interfaces:
Serializable, Comparable<SharingEntryAction>, Constable

public enum SharingEntryAction extends 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 Details

  • Method Details

    • values

      public static SharingEntryAction[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static SharingEntryAction valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null
    • getSharingEntryActions

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