Interface Permission

All Superinterfaces:
KeyValuePair<String,String>, Persistent, Serializable

public interface Permission extends Persistent
This interface describes a single permission, the base of the @enterprise permission system. A permission describes WHO (agent) has which RIGHT on which OBJECT (target).
  • Field Details

    • GLOBAL

      static final int GLOBAL
      Entry has global scope (department independent)
      See Also:
    • LOCAL

      static final int LOCAL
      Entry has local scope.
      See Also:
    • HIERARCHIC

      static final int HIERARCHIC
      Scope is the deparment and all sub-departments
      See Also:
    • HIERARCHIC_DEP

      static final int HIERARCHIC_DEP
      The dependent sub-departments
      See Also:
    • INDEPENDENT_SUPER

      static final int INDEPENDENT_SUPER
      The upwards-next independent department
      See Also:
    • DEPENDENT_TREE

      static final int DEPENDENT_TREE
      The tree of the independent dept and the dependent sub-depts
      See Also:
    • SUPER

      static final int SUPER
      The parent department
      See Also:
    • ALL_OBJECTS

      static final int ALL_OBJECTS
      The scope is: all object
      See Also:
    • OBJECT_CLASS

      static final int OBJECT_CLASS
      The scope is: an object class
      See Also:
    • OBJECT

      static final int OBJECT
      Scope is the a specific object
      See Also:
    • ROLE_DEPT

      static final int ROLE_DEPT
      Scope is the department of the object
      See Also:
    • DEPT

      static final int DEPT
      Scope is the given department or the department of the object
      See Also:
  • Method Details

    • getAgent

      Agent getAgent()
      Return the agent the permission is granted to.
      Returns:
      the agent (user or role)
    • setAgent

      void setAgent(Agent a)
      Set the agent of the permission.
    • getOrgUnit

      OrgUnit getOrgUnit()
      Get the org unit of the permission.
    • setOrgUnit

      void setOrgUnit(OrgUnit ou)
      Set the org-unit of the permission.
    • getRight

      Right getRight()
      Returns the right the permission grants
      Returns:
      the name, a string object
    • setRight

      void setRight(Right r)
      Set the right of the permission.
    • getTarget

      Persistent getTarget()
      Returns the target object.
      Returns:
      a persistent
    • setTarget

      void setTarget(Persistent target)
      Set the target object.
      Parameters:
      target - a persistent
    • isPositive

      boolean isPositive()
      Returns true if the permission is positive.
    • setPositive

      void setPositive(boolean pos)
      Set the permission positive (right is given) or negative (right is revoked)
    • setOrgScope

      void setOrgScope(int scope)
      Set the org-scope to one of the following values: GLOBAL, LOCAL, HIERARCHIC, HIERARCHIC_DEP, INDEPENDENT_SUPER, DEPENDENT_TREE, SUPER.
    • setObjScope

      void setObjScope(int scope)
      Set the object-scope to one of the following values: ALL_OBJECTS, OBJECT_CLASS, OBJECT, ROLE_DEPT, DEPT
    • getOrgScope

      int getOrgScope()
      Returns the org-scope.
    • getObjScope

      int getObjScope()
      Returns the object-scope.
    • getFromDate

      Date getFromDate()
      Get the start date of the permission.
      Returns:
      the start date
    • setFromDate

      void setFromDate(Date startDate)
    • getToDate

      Date getToDate()
    • setToDate

      void setToDate(Date endDate)
    • ignoreSubst

      boolean ignoreSubst()
      Returns true if the permission does ignore substitutions.
    • setIgnoreSubst

      void setIgnoreSubst(boolean ignore)
      Set to true if you want that the permission is not valid for substitutions.