org.apache.portals.graffito.model.permission
Interface CmsPermission

public interface CmsPermission

Permission apply to a cms object like view, update, delete, ... The permission can be apply : - Only on the cms object itself - on the object and its children - Recursively on all children and subfolders

Version:

$Id: Exp $

Author:

Lombart Christophe

Field Summary

static java.lang.String	ALL All action authorized on a cms object
static java.lang.String	DELETE Delete a cms object
static java.lang.String	EDIT Edit a cms object
static java.lang.String	INSERT Insert a cms object
static java.lang.String	LOCK Lock a cms object
static java.lang.String	UNLOCK Unlock a cms object
static java.lang.String	UPDATE Update a cms object
static java.lang.String	VIEW View a cms object

Method Summary

java.lang.String	getActions() Get the action allowed by this permission (view, delete, ...) "all" can be used to apply all permission on the cms object
java.lang.String	getName() Get the permission name.
java.util.Collection	getPrincipalFullPaths() Get all principals assigned to this permissions
boolean	isApplyToChildren() Check if the permission is applying only on the document children (not on the subfolder)
boolean	isRecursive() Check if the permission is applying recursivly on all subfolder & content children

Field Detail

VIEW

static final java.lang.String VIEW

View a cms object

See Also:

Constant Field Values

EDIT

static final java.lang.String EDIT

Edit a cms object

See Also:

Constant Field Values

LOCK

static final java.lang.String LOCK

Lock a cms object

See Also:

Constant Field Values

UNLOCK

static final java.lang.String UNLOCK

Unlock a cms object

See Also:

Constant Field Values

DELETE

static final java.lang.String DELETE

Delete a cms object

See Also:

Constant Field Values

INSERT

static final java.lang.String INSERT

Insert a cms object

See Also:

Constant Field Values

UPDATE

static final java.lang.String UPDATE

Update a cms object

See Also:

Constant Field Values

ALL

static final java.lang.String ALL

All action authorized on a cms object

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()

Get the permission name. The name match to the cms object uri. The name contains an "*" if this permission has to be apply on children The name contains an "-" if this permission has to be apply recusively

Returns:

The permission name

getActions

java.lang.String getActions()

Get the action allowed by this permission (view, delete, ...) "all" can be used to apply all permission on the cms object

Returns:

the allowed actions

getPrincipalFullPaths

java.util.Collection getPrincipalFullPaths()

Get all principals assigned to this permissions

Returns:

the the principal full paths (eg. /users/christophe, /groups/admin, ...)

isRecursive

boolean isRecursive()

Check if the permission is applying recursivly on all subfolder & content children

Returns:

true if the permission is applying on all subfolder & content children

isApplyToChildren

boolean isApplyToChildren()

Check if the permission is applying only on the document children (not on the subfolder)

Returns:

true if the permission is applying only on content children