com.flexive.shared.security
Class ACL

java.lang.Object
  extended by com.flexive.shared.AbstractSelectableObjectWithName
      extended by com.flexive.shared.security.ACL
All Implemented Interfaces:
ObjectWithColor, ObjectWithLabel, SelectableObject, SelectableObjectWithLabel, SelectableObjectWithName, java.io.Serializable

public class ACL
extends AbstractSelectableObjectWithName
implements java.io.Serializable, SelectableObjectWithLabel, ObjectWithColor

Data class for the access control lists

Author:
Gregor Schober (gregor.schober@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at)
See Also:
Serialized Form

Nested Class Summary
static class ACL.Category
          ACL categories and their defaults
static class ACL.Permission
          ACL permissions
 
Field Summary
static long ACL_CONTACTDATA
          Contact Data ACL
static long MAX_INTERNAL_ID
          Max.
 
Constructor Summary
ACL()
          Constructor
ACL(ACL acl)
          Copy Constructor
ACL(long id, java.lang.String name, FxString label, long mandatorId, java.lang.String mandator, java.lang.String description, java.lang.String color, ACL.Category category, LifeCycleInfo lifeCycleInfo)
          Constructor.
 
Method Summary
 ACL.Category getCategory()
          Returns the category of the ACL.
 java.lang.String getColor()
          Returns the color of the ACL.
 java.lang.String getDescription()
          Returns the description of the ACL.
 long getId()
          Returns the unique id of the ACL.
 FxString getLabel()
          Get the display label of this ACL
 LifeCycleInfo getLifeCycleInfo()
          Get lifecycle information
 long getMandatorId()
          Returns the mandator the ACL belongs to.
 java.lang.String getMandatorName()
          Returns the name of the mandator.
 java.lang.String getName()
          Returns the unique name of the ACL.
 void setCategory(ACL.Category cat)
          Returns the category of the ACL.
 void setColor(java.lang.String color)
          Sets the color of the ACL.
 void setDescription(java.lang.String desc)
          Sets the the description of the ACL.
 void setLabel(FxString label)
          Set the display label of this ACL
 void setName(java.lang.String name)
          Sets the unique name of the ACL.
 java.lang.String toString()
          
 
Methods inherited from class com.flexive.shared.AbstractSelectableObjectWithName
equals, hashCode
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

MAX_INTERNAL_ID

public static final long MAX_INTERNAL_ID
Max. id for internal ACL's (needed for internal checks)

See Also:
Constant Field Values

ACL_CONTACTDATA

public static final long ACL_CONTACTDATA
Contact Data ACL

See Also:
Constant Field Values
Constructor Detail

ACL

public ACL()
Constructor


ACL

public ACL(ACL acl)
Copy Constructor

Parameters:
acl - ACL to copy

ACL

public ACL(long id,
           java.lang.String name,
           FxString label,
           long mandatorId,
           java.lang.String mandator,
           java.lang.String description,
           java.lang.String color,
           ACL.Category category,
           LifeCycleInfo lifeCycleInfo)
Constructor.

Parameters:
id - the unique id
name - the name
label - display label
mandatorId - the id of the mandator the acl belongs to
mandator - the name of the mandator
description - the description
color - the color (RGB code or style class)
category - the category
lifeCycleInfo - lifecycle information
Method Detail

getId

public long getId()
Returns the unique id of the ACL.

Specified by:
getId in interface SelectableObject
Returns:
the unique id of the ACL

getName

public java.lang.String getName()
Returns the unique name of the ACL.

Specified by:
getName in interface SelectableObjectWithName
Returns:
the unique name of the ACL.

getDescription

public java.lang.String getDescription()
Returns the description of the ACL. The desciption is never null, but may be a empty String.

Returns:
the description of the ACL.

getColor

public java.lang.String getColor()
Returns the color of the ACL. A empty String may be returned if the default color should be used.

Specified by:
getColor in interface ObjectWithColor
Returns:
the color of the ACL

getCategory

public ACL.Category getCategory()
Returns the category of the ACL.

Returns:
the category of the ACL

getLifeCycleInfo

public LifeCycleInfo getLifeCycleInfo()
Get lifecycle information

Returns:
lifecycle information

getMandatorId

public long getMandatorId()
Returns the mandator the ACL belongs to.

Returns:
the mandator the ACL belongs to

setName

public void setName(java.lang.String name)
Sets the unique name of the ACL.

Parameters:
name - the new name

getLabel

public FxString getLabel()
Get the display label of this ACL

Specified by:
getLabel in interface ObjectWithLabel
Returns:
display label

setLabel

public void setLabel(FxString label)
Set the display label of this ACL

Parameters:
label - display label

setDescription

public void setDescription(java.lang.String desc)
Sets the the description of the ACL.

Parameters:
desc - the new description

setColor

public void setColor(java.lang.String color)
Sets the color of the ACL.

Parameters:
color - the color of the ACL

setCategory

public void setCategory(ACL.Category cat)
Returns the category of the ACL.

Parameters:
cat - the category of the ACL

getMandatorName

public java.lang.String getMandatorName()
Returns the name of the mandator.

Returns:
the name of the mandator

toString

public java.lang.String toString()
Description copied from class: AbstractSelectableObjectWithName

Overrides:
toString in class AbstractSelectableObjectWithName