Interface PermissionEntry

All Known Implementing Classes:
AbstractPermissionEntry, GlobalPermissionEntry, ModelPermissionEntry, SimplePermissionEntry

public interface PermissionEntry
A single permission entry defined against a node.
Author:
andyh
  • Method Summary

    Modifier and Type
    Method
    Description
    Get the Access enum value
    Get the authority to which this entry applies This could be the string value of a username, group, role or any other authority assigned to the authorisation.
    Get the node ref for the node to which this permission applies.
    Get the permission definition.
    int
    Return the position in the inhertance chain (0 is not inherited and set on the object)
    boolean
    Is permission allowed?
    boolean
    Is permissions denied?
    boolean
    Is this permission inherited?
  • Method Details

    • getPermissionReference

      PermissionReference getPermissionReference()
      Get the permission definition. This may be null. Null implies that the settings apply to all permissions
      Returns:
      PermissionReference
    • getAuthority

      String getAuthority()
      Get the authority to which this entry applies This could be the string value of a username, group, role or any other authority assigned to the authorisation. If null then this applies to all.
      Returns:
      String
    • getNodeRef

      NodeRef getNodeRef()
      Get the node ref for the node to which this permission applies. This can only be null for a global permission
      Returns:
      NodeRef
    • isDenied

      boolean isDenied()
      Is permissions denied?
    • isAllowed

      boolean isAllowed()
      Is permission allowed?
    • getAccessStatus

      AccessStatus getAccessStatus()
      Get the Access enum value
      Returns:
      AccessStatus
    • isInherited

      boolean isInherited()
      Is this permission inherited?
      Returns:
      boolean
    • getPosition

      int getPosition()
      Return the position in the inhertance chain (0 is not inherited and set on the object)
      Returns:
      int