ch.elexis.admin
Class ACE

java.lang.Object
  ch.elexis.admin.ACE

All Implemented Interfaces:

java.io.Serializable

public class ACE
extends java.lang.Object
implements java.io.Serializable

AcessControlElement: An item constituting a named right. AccessControlElements are collected hiearchically in ACL's (AccessControlLists). An ACE has a parent, an internal name and a (probably localized) external name that will be shown to the user

Since:

2.0

Author:

gerry

See Also:

Serialized Form

Field Summary

static ACE	ACE_IMPLICIT
static ACE	ACE_ROOT

Constructor Summary

ACE(ACE parent, java.lang.String name)
create a new ACE without localized name.

ACE(ACE parent, java.lang.String name, java.lang.String localizedName)
Create a new ACE.

Method Summary

java.lang.String	getLocalizedName()
java.lang.String	getName()
ACE	getParent()
void	setLocalizedName(java.lang.String lName) Change the localized name of this ACE

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ACE_ROOT

public static final ACE ACE_ROOT

ACE_IMPLICIT

public static final ACE ACE_IMPLICIT

Constructor Detail

ACE

public ACE(ACE parent,
           java.lang.String name,
           java.lang.String localizedName)

Create a new ACE. This is the recommended constructor for most cases.

Parameters:

parent - the parent ACE. If this is a top-evel ACE, use ACE_ROOT as parent.

name - the internal, immutable name of this ACE. Should be unique. Therefore, it is recommended to prefix the name with the plugin ID

localizedName - the name that will be presented to the user. Thsi should be a translatable String

ACE

public ACE(ACE parent,
           java.lang.String name)

create a new ACE without localized name. The localized name will be the same as the internal name. So this constructor should not be used for ACE's that will be shown to the user.

Parameters:

parent - the parent ACE. If this is a top-evel ACE, use ACE_ROOT as parent.

name - the internal, immutable name of this ACE. Should be unique. Therefore, it is recommended to prefix the name with the plugin ID.

Method Detail

getName

public java.lang.String getName()

Returns:

the non-translatable name of this ACE

getLocalizedName

public java.lang.String getLocalizedName()

Returns:

the localized Name of this ACE

getParent

public ACE getParent()

Returns:

the parent ACE

setLocalizedName

public void setLocalizedName(java.lang.String lName)

Change the localized name of this ACE

Parameters:

lName - a new name to use as localized name