org.alfresco.repo.security.permissions.impl
Interface ModelDAO

All Known Implementing Classes:
PermissionModel

public interface ModelDAO

The API for the alfresco permission model.


Method Summary
 boolean checkPermission(PermissionReference required)
          Is this permission refernece to a permission and not a permissoinSet?
 java.util.Set getAllExposedPermissions()
          Get all exposed permissions (regardless of type exposure)
 java.util.Set getAllPermissions()
          Get all exposed permissions (regardless of type exposure)
 java.util.Set getAllPermissions(org.alfresco.service.cmr.repository.NodeRef nodeRef)
          Get the permissions that can be set for the given node.
 java.util.Set getAllPermissions(org.alfresco.service.namespace.QName type)
          Get the permissions that can be set for the given type.
 java.util.Set getAllPermissions(org.alfresco.service.namespace.QName type, java.util.Set aspects)
          Get the permissions that can be set for the given type.
 java.util.Set getExposedPermissions(org.alfresco.service.cmr.repository.NodeRef nodeRef)
          Get the permissions that are exposed to be set for the given node.
 java.util.Set getExposedPermissions(org.alfresco.service.namespace.QName type)
          Get the permissions that are exposed to be set for the given type.
 java.util.Set getGlobalPermissionEntries()
          Get the global permissions for the model.
 java.util.Set getGranteePermissions(PermissionReference permissionReference)
          Get the permissions which are granted by the supplied permission.
 java.util.Set getGrantingPermissions(PermissionReference perm)
          Get all the permissions that grant this permission.
 java.util.Set getImmediateGranteePermissions(PermissionReference permissionReference)
          Get the permissions which are granted by the supplied permission.
 PermissionReference getPermissionReference(org.alfresco.service.namespace.QName qname, java.lang.String permissionName)
          Find a permission by name in the type context.
 java.util.Set getRequiredPermissions(PermissionReference required, org.alfresco.service.namespace.QName qName, java.util.Set aspectQNames, RequiredPermission.On on)
          Get the permissions that must also be present on the node for the required permission to apply.
 java.util.Set getUnconditionalRequiredPermissions(PermissionReference required, RequiredPermission.On on)
           
 boolean hasFull(PermissionReference permissionReference)
          Does this permission allow full control?
 boolean isUnique(PermissionReference permissionReference)
          Does the permission reference have a unique name?
 

Method Detail

getAllPermissions

java.util.Set getAllPermissions(org.alfresco.service.namespace.QName type)
Get the permissions that can be set for the given type.

Parameters:
type - - the type in the data dictionary.
Returns:

getAllPermissions

java.util.Set getAllPermissions(org.alfresco.service.namespace.QName type,
                                java.util.Set aspects)
Get the permissions that can be set for the given type.

Parameters:
type - - the type in the data dictionary.
aspects -
Returns:

getAllPermissions

java.util.Set getAllPermissions(org.alfresco.service.cmr.repository.NodeRef nodeRef)
Get the permissions that can be set for the given node. This is determined by the node type.

Parameters:
nodeRef -
Returns:

getExposedPermissions

java.util.Set getExposedPermissions(org.alfresco.service.namespace.QName type)
Get the permissions that are exposed to be set for the given type.

Parameters:
type - - the type in the data dictionary.
Returns:

getExposedPermissions

java.util.Set getExposedPermissions(org.alfresco.service.cmr.repository.NodeRef nodeRef)
Get the permissions that are exposed to be set for the given node. This is determined by the node type.

Parameters:
nodeRef -
Returns:

getGrantingPermissions

java.util.Set getGrantingPermissions(PermissionReference perm)
Get all the permissions that grant this permission.

Parameters:
perm -
Returns:

getRequiredPermissions

java.util.Set getRequiredPermissions(PermissionReference required,
                                     org.alfresco.service.namespace.QName qName,
                                     java.util.Set aspectQNames,
                                     RequiredPermission.On on)
Get the permissions that must also be present on the node for the required permission to apply.

Parameters:
required -
qName -
aspectQNames -
on -
Returns:

getUnconditionalRequiredPermissions

java.util.Set getUnconditionalRequiredPermissions(PermissionReference required,
                                                  RequiredPermission.On on)

getGranteePermissions

java.util.Set getGranteePermissions(PermissionReference permissionReference)
Get the permissions which are granted by the supplied permission.

Parameters:
permissionReference -
Returns:

getImmediateGranteePermissions

java.util.Set getImmediateGranteePermissions(PermissionReference permissionReference)
Get the permissions which are granted by the supplied permission.

Parameters:
permissionReference -
Returns:

checkPermission

boolean checkPermission(PermissionReference required)
Is this permission refernece to a permission and not a permissoinSet?

Parameters:
required -
Returns:

isUnique

boolean isUnique(PermissionReference permissionReference)
Does the permission reference have a unique name?

Parameters:
permissionReference -
Returns:

getPermissionReference

PermissionReference getPermissionReference(org.alfresco.service.namespace.QName qname,
                                           java.lang.String permissionName)
Find a permission by name in the type context. If the context is null and the permission name is unique it will be found.

Parameters:
qname -
permissionName -
Returns:

getGlobalPermissionEntries

java.util.Set getGlobalPermissionEntries()
Get the global permissions for the model. Permissions that apply to all nodes and take precedence over node specific permissions.

Returns:

getAllExposedPermissions

java.util.Set getAllExposedPermissions()
Get all exposed permissions (regardless of type exposure)

Returns:

getAllPermissions

java.util.Set getAllPermissions()
Get all exposed permissions (regardless of type exposure)

Returns:

hasFull

boolean hasFull(PermissionReference permissionReference)
Does this permission allow full control?

Parameters:
permissionReference -
Returns:


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.