Elexis API documentation
Version 2.1.6 as of December 11 2011

ch.elexis.agenda.acl
Class ACLContributor

java.lang.Object
  extended by ch.elexis.agenda.acl.ACLContributor
All Implemented Interfaces:
IACLContributor

public class ACLContributor
extends java.lang.Object
implements IACLContributor

Define access rights needed for the various actions with the agenda

Author:
gerry

Field Summary
static ACE ACE_AGENDA
          The right to use the agenda at all
static ACE ADMIN_AGENDA
          administrative rights to the agenda
static ACE CHANGE_APPLOCK
          The right to lock or unlock appointments
static ACE CHANGE_APPOINTMENTS
          The right to modify appointments
static ACE CHANGE_DAYSETTINGS
          The right to modify the day limits
static ACE DELETE_APPOINTMENTS
          The right to delete appointments
static ACE DISPLAY_APPOINTMENTS
          The right to see appointments
static ACE USE_AGENDA
           
 
Constructor Summary
ACLContributor()
           
 
Method Summary
 ACE[] getACL()
          get the ACE's that should be managed.
static void initialize()
          On first run of the agenda, set the rights to reasonable defaults
 ACE[] reject(ACE[] acl)
          react on errors reserving rights
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ACE_AGENDA

public static final ACE ACE_AGENDA
The right to use the agenda at all


USE_AGENDA

public static final ACE USE_AGENDA

ADMIN_AGENDA

public static final ACE ADMIN_AGENDA
administrative rights to the agenda


DISPLAY_APPOINTMENTS

public static final ACE DISPLAY_APPOINTMENTS
The right to see appointments


CHANGE_APPOINTMENTS

public static final ACE CHANGE_APPOINTMENTS
The right to modify appointments


DELETE_APPOINTMENTS

public static final ACE DELETE_APPOINTMENTS
The right to delete appointments


CHANGE_DAYSETTINGS

public static final ACE CHANGE_DAYSETTINGS
The right to modify the day limits


CHANGE_APPLOCK

public static final ACE CHANGE_APPLOCK
The right to lock or unlock appointments

Constructor Detail

ACLContributor

public ACLContributor()
Method Detail

getACL

public ACE[] getACL()
get the ACE's that should be managed.

Specified by:
getACL in interface IACLContributor
Returns:
an array of all ACE's to insert

reject

public ACE[] reject(ACE[] acl)
react on errors reserving rights

Specified by:
reject in interface IACLContributor
Parameters:
acl - array of all rejected acls (these have not been integrated)
Returns:
the plugin can return an array of corrected acls or null.

initialize

public static void initialize()
On first run of the agenda, set the rights to reasonable defaults


Elexis API documentation
Version 2.1.6 as of December 11 2011

Copyright 2005-2011 by Gerry Weirich, Elexis