Package stroom.query.authorisation

Enum DocumentPermission

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<DocumentPermission>, java.lang.constant.Constable
    public enum DocumentPermission
extends java.lang.Enum<DocumentPermission>
    This known actions that require permission.

    • Nested Class Summary

      • Nested classes/interfaces inherited from class java.lang.Enum

        java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      CREATE
      Users with the create permission can find and create/saveAs documents.
      DELETE
      Users with delete permission can find, create, read, update and delete documents.
      EXPORT
      Users with export permission can export documents.
      IMPORT
      Users with import permission can import documents that they have create and update permissions for.
      OWNER
      Owners have permission to find, create, read, update and delete documents plus they can change permissions.
      READ
      Users with the read permission can find, create and read/load/view documents.
      UPDATE
      Users with the update permission can find, create, read and update/save documents.
      USE
      Users with the use permission can use documents.

    • Method Summary

      Modifier and Type Method Description
      java.lang.String getName()  
      java.lang.String getTypedPermission​(java.lang.String docType)  
      static DocumentPermission valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static DocumentPermission[] 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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • USE

        public static final DocumentPermission USE
        Users with the use permission can use documents.

      • CREATE

        public static final DocumentPermission CREATE
        Users with the create permission can find and create/saveAs documents.

      • READ

        public static final DocumentPermission READ
        Users with the read permission can find, create and read/load/view documents.

      • UPDATE

        public static final DocumentPermission UPDATE
        Users with the update permission can find, create, read and update/save documents.

      • DELETE

        public static final DocumentPermission DELETE
        Users with delete permission can find, create, read, update and delete documents.

      • OWNER

        public static final DocumentPermission OWNER
        Owners have permission to find, create, read, update and delete documents plus they can change permissions.

      • IMPORT

        public static final DocumentPermission IMPORT
        Users with import permission can import documents that they have create and update permissions for.

      • EXPORT

        public static final DocumentPermission EXPORT
        Users with export permission can export documents.

    • Method Detail

      • values

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

      • valueOf

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

      • getName

        public java.lang.String getName()

      • getTypedPermission

        public java.lang.String getTypedPermission​(java.lang.String docType)