Permission ( @enterprise 10.0 API)

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 Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALL_OBJECTS` The scope is: all object
`static int`	`DEPENDENT_TREE` The tree of the independent dept and the dependent sub-depts
`static int`	`DEPT` Scope is the given department or the department of the object
`static int`	`GLOBAL` Entry has global scope (department independent)
`static int`	`HIERARCHIC` Scope is the deparment and all sub-departments
`static int`	`HIERARCHIC_DEP` The dependent sub-departments
`static int`	`INDEPENDENT_SUPER` The upwards-next independent department
`static int`	`LOCAL` Entry has local scope.
`static int`	`OBJECT` Scope is the a specific object
`static int`	`OBJECT_CLASS` The scope is: an object class
`static int`	`ROLE_DEPT` Scope is the department of the object
`static int`	`SUPER` The parent department

Fields inherited from interface com.groiss.store.Persistent
emptyKeys

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Agent`	`getAgent()` Return the agent the permission is granted to.
`Date`	`getFromDate()` Get the start date of the permission.
`int`	`getObjScope()` Returns the object-scope.
`int`	`getOrgScope()` Returns the org-scope.
`OrgUnit`	`getOrgUnit()` Get the org unit of the permission.
`Right`	`getRight()` Returns the right the permission grants
`Persistent`	`getTarget()` Returns the target object.
`Date`	`getToDate()`
`boolean`	`ignoreSubst()` Returns true if the permission does ignore substitutions.
`boolean`	`isPositive()` Returns true if the permission is positive.
`void`	`setAgent(Agent a)` Set the agent of the permission.
`void`	`setFromDate(Date startDate)`
`void`	`setIgnoreSubst(boolean ignore)` Set to true if you want that the permission is not valid for substitutions.
`void`	`setObjScope(int scope)` Set the object-scope to one of the following values: ALL_OBJECTS, OBJECT_CLASS, OBJECT, ROLE_DEPT, DEPT
`void`	`setOrgScope(int scope)` Set the org-scope to one of the following values: GLOBAL, LOCAL, HIERARCHIC, HIERARCHIC_DEP, INDEPENDENT_SUPER, DEPENDENT_TREE, SUPER.
`void`	`setOrgUnit(OrgUnit ou)` Set the org-unit of the permission.
`void`	`setPositive(boolean pos)` Set the permission positive (right is given) or negative (right is revoked)
`void`	`setRight(Right r)` Set the right of the permission.
`void`	`setTarget(Persistent target)` Set the target object.
`void`	`setToDate(Date endDate)`

Methods inherited from interface com.groiss.store.Persistent
afterDelete, afterInsert, afterRead, afterUpdate, beforeDelete, beforeInsert, beforeUpdate, dbFields, getKey, getKeys, getLocalClassName, getLocalObjectName, getOid, getStore, getTableName, getValue, isFilled, isValid, setFilled, setOid, setOid, setStore, toListString

- Field Detail
  - GLOBAL
```
static final int GLOBAL
```
    Entry has global scope (department independent)
    
    See Also:
    
    Constant Field Values
  - LOCAL
```
static final int LOCAL
```
    Entry has local scope.
    
    See Also:
    
    Constant Field Values
  - HIERARCHIC
```
static final int HIERARCHIC
```
    Scope is the deparment and all sub-departments
    
    See Also:
    
    Constant Field Values
  - HIERARCHIC_DEP
```
static final int HIERARCHIC_DEP
```
    The dependent sub-departments
    
    See Also:
    
    Constant Field Values
  - INDEPENDENT_SUPER
```
static final int INDEPENDENT_SUPER
```
    The upwards-next independent department
    
    See Also:
    
    Constant Field Values
  - DEPENDENT_TREE
```
static final int DEPENDENT_TREE
```
    The tree of the independent dept and the dependent sub-depts
    
    See Also:
    
    Constant Field Values
  - SUPER
```
static final int SUPER
```
    The parent department
    
    See Also:
    
    Constant Field Values
  - ALL_OBJECTS
```
static final int ALL_OBJECTS
```
    The scope is: all object
    
    See Also:
    
    Constant Field Values
  - OBJECT_CLASS
```
static final int OBJECT_CLASS
```
    The scope is: an object class
    
    See Also:
    
    Constant Field Values
  - OBJECT
```
static final int OBJECT
```
    Scope is the a specific object
    
    See Also:
    
    Constant Field Values
  - ROLE_DEPT
```
static final int ROLE_DEPT
```
    Scope is the department of the object
    
    See Also:
    
    Constant Field Values
  - DEPT
```
static final int DEPT
```
    Scope is the given department or the department of the object
    
    See Also:
    
    Constant Field Values
- Method Detail
  - 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.

Interface Permission

Field Summary

Fields inherited from interface com.groiss.store.Persistent

Method Summary

Methods inherited from interface com.groiss.store.Persistent

Field Detail

GLOBAL

LOCAL

HIERARCHIC

HIERARCHIC_DEP

INDEPENDENT_SUPER

DEPENDENT_TREE

SUPER

ALL_OBJECTS

OBJECT_CLASS

OBJECT

ROLE_DEPT

DEPT

Method Detail

getAgent

setAgent

getOrgUnit

setOrgUnit

getRight

setRight

getTarget

setTarget

isPositive

setPositive

setOrgScope

setObjScope

getOrgScope

getObjScope

getFromDate

setFromDate

getToDate

setToDate

ignoreSubst

setIgnoreSubst