com.wewebu.ow.server.ecm
Interface OwPermissionCollection


public interface OwPermissionCollection

Base interface for ECM System specific permissions objects. Supports policies (ACL's) and privilege set's.

Alfresco Workdesk
Copyright (c) Alfresco Software, Inc.
All rights reserved.

For licensing information read the license.txt file or
go to: http://wiki.alfresco.com


Method Summary
 void addPolicy(OwPolicy policy_p)
          add the given policy for single policy archives addPolicy will replace the previous policy
 OwPrivilegeSet addPrivilegeSet(OwUserInfo principal_p, Collection privileges_p, boolean deny_p, int inheritancedepth_p)
          create and add a new privilege set the new set is applied immediately to the object
 boolean canAddMultiPolicy()
          check if multiple policies can be set, otherwise only one policy can be applied at a time if true addPolicy will replace the previous policy
 boolean canDenyPrivileges()
          check if privileges can be denied i.e.
 OwReason canEditPermissions()
          Method to verify if the permission can be edit.
 boolean canGetPolicies()
          check if policies can be retrieved
 boolean canGetPrivileges()
          check if privileges can be retrieved
 boolean canSetPolicies()
          check if policies can be set
 boolean canSetPrivileges()
          check if privileges can be set
 Collection getAppliedPolicies()
          get a collection of all applied policies
 Collection getAppliedPrivilegeSets()
          get a collection of all applied privilege sets
 Map getAvailableInheritanceDepths()
          get a collection of applicable levels for inheritance depth
 Collection getAvailablePolicies(OwUserInfo principal_p)
          get a collection of policies that are applicable for the object and can be used in addPolicy for the given principal
 Collection getAvailablePrivileges(OwUserInfo principal_p)
          get a collection of privileges that are applicable for the object and can be used in addPrivilegeSet for the given principal
 void removePolicy(OwPolicy policy_p)
          remove the given privilege set
 void removePrivilegeSet(OwPrivilegeSet privilegeset_p)
          remove the given privilege set
 

Method Detail

canGetPrivileges

boolean canGetPrivileges()
check if privileges can be retrieved

Returns:
boolean

canSetPrivileges

boolean canSetPrivileges()
check if privileges can be set

Returns:
boolean

canDenyPrivileges

boolean canDenyPrivileges()
check if privileges can be denied i.e. if deny_p parameter in addPrivilegeSet is allowed

Returns:
boolean

getAvailablePrivileges

Collection getAvailablePrivileges(OwUserInfo principal_p)
get a collection of privileges that are applicable for the object and can be used in addPrivilegeSet for the given principal

Parameters:
principal_p -
Returns:
Collection of OwPrivilege

getAvailableInheritanceDepths

Map getAvailableInheritanceDepths()
get a collection of applicable levels for inheritance depth

Returns:
Map of display strings keyed by Integer depth level's, or null if no depth support is available

addPrivilegeSet

OwPrivilegeSet addPrivilegeSet(OwUserInfo principal_p,
                               Collection privileges_p,
                               boolean deny_p,
                               int inheritancedepth_p)
                               throws OwException
create and add a new privilege set the new set is applied immediately to the object

Parameters:
principal_p -
privileges_p - Collection of OwPrivilege
deny_p -
inheritancedepth_p - depth level to which this set is applied for child objects, as defined in OwPrivilegeSet.INHERITANCE_DEPTH_... or by getAvailableInheritanceDepths
Returns:
OwPrivilegeSet
Throws:
OwException

getAppliedPrivilegeSets

Collection getAppliedPrivilegeSets()
get a collection of all applied privilege sets

Returns:
Collection of OwPrivilegeSet

removePrivilegeSet

void removePrivilegeSet(OwPrivilegeSet privilegeset_p)
                        throws OwException
remove the given privilege set

Parameters:
privilegeset_p -
Throws:
OwException

canGetPolicies

boolean canGetPolicies()
check if policies can be retrieved

Returns:
boolean

canSetPolicies

boolean canSetPolicies()
check if policies can be set

Returns:
boolean

canAddMultiPolicy

boolean canAddMultiPolicy()
check if multiple policies can be set, otherwise only one policy can be applied at a time if true addPolicy will replace the previous policy

Returns:
boolean

getAvailablePolicies

Collection getAvailablePolicies(OwUserInfo principal_p)
get a collection of policies that are applicable for the object and can be used in addPolicy for the given principal

Parameters:
principal_p -
Returns:
Collection of OwPolicy

addPolicy

void addPolicy(OwPolicy policy_p)
               throws OwException
add the given policy for single policy archives addPolicy will replace the previous policy

Parameters:
policy_p -
Throws:
OwException

getAppliedPolicies

Collection getAppliedPolicies()
get a collection of all applied policies

Returns:
Collection of OwPolicy

removePolicy

void removePolicy(OwPolicy policy_p)
                  throws OwException
remove the given privilege set

Parameters:
policy_p -
Throws:
OwException

canEditPermissions

OwReason canEditPermissions()
Method to verify if the permission can be edit.

Returns:
OwReason with possible reason descriptions.
Since:
3.0.0.0
See Also:
OwReason


Copyright © 2013 Alfresco Business Solutions. All Rights Reserved.