Package com.logicaldoc.core.security

Enum Permission

  • All Implemented Interfaces:
    Serializable, Comparable<Permission>
    public enum Permission
extends Enum<Permission>
    Models a permission, that is the ability to do something
    • READ: ability to read the folder and its documents
    • WRITE: ability to insert and delete folder's documents
    • ADD: ability to add child elements
    • SECURITY: ability to change security rules
    • IMMUTABILE: ability to mark a document as immutable
    • DELETE: ability to delete the entity
    • RENAME: ability to rename the entity
    • IMPORT: ability to import documents
    • EXPORT: ability to export documents
    • SIGN: ability to digitally sign documents
    • ARCHIVE: ability to archive documents
    • WORKFLOW: ability to handle workflow
    • CALENDAR: ability to handle calendar events
    • SUBSCRIPTION: ability to handle events subscription
    • PRINT: ability to print
    • PASSWORD: ability to put a password in a document
    • MOVE: ability to move documents
    • EMAIL: ability to send emails
    • AUTOMATION: ability to handle the automation
    Since:
    4.0
    Author:
    Marco Meschieri - LogicalDOC

    • Method Detail

      • values

        public static Permission[] 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 (Permission c : Permission.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

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

      • getName

        public String getName()

      • getMask

        public int getMask()

      • match

        public boolean match​(int permission)

      • valueOf

        public static Permission valueOf​(int mask)
        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:
        mask - 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