org.alfresco.module.org_alfresco_module_rm.capability

Class CapabilityServiceImpl

java.lang.Object

org.alfresco.module.org_alfresco_module_rm.capability.CapabilityServiceImpl

All Implemented Interfaces:

CapabilityService

public class CapabilityServiceImpl
extends Object
implements CapabilityService

Since:

2.0

Author:

Roy Wetherall

Constructor Summary

Constructors

Constructor and Description
CapabilityServiceImpl()

Method Summary

Modifier and Type	Method and Description
void	addGroup(Group group) Adds a group to the list of groups
Set<Capability>	getCapabilities() Get a list of all the assignable capabilities.
Set<Capability>	getCapabilities(boolean includePrivate) Get a list of all the capabilities, optionally including those that are non-assignable.
Map<Capability,org.alfresco.service.cmr.security.AccessStatus>	getCapabilitiesAccessState(org.alfresco.service.cmr.repository.NodeRef nodeRef) Get all the capabilities access state based on the current user for the assignable capabilities.
Map<Capability,org.alfresco.service.cmr.security.AccessStatus>	getCapabilitiesAccessState(org.alfresco.service.cmr.repository.NodeRef nodeRef, boolean includePrivate) Get all the capabilities access state based on the current user.
Map<Capability,org.alfresco.service.cmr.security.AccessStatus>	getCapabilitiesAccessState(org.alfresco.service.cmr.repository.NodeRef nodeRef, List<String> capabilityNames)
List<Capability>	getCapabilitiesByGroup(Group group) Get a list of capabilities for the given group
List<Capability>	getCapabilitiesByGroupId(String groupId) Gets a list of capabilities for the given group id
Capability	getCapability(String name) Get a named capability.
org.alfresco.service.cmr.security.AccessStatus	getCapabilityAccessState(org.alfresco.service.cmr.repository.NodeRef nodeRef, String capabilityName) Helper method to get the access state for a single capability.
Group	getGroup(String groupId) Gets a group from it's id
List<Group>	getGroups() Gets the list of all the capability groups (in index order)
boolean	hasCapability(org.alfresco.service.cmr.repository.NodeRef nodeRef, String capabilityName) Check if the current user has the given capability.
void	registerCapability(Capability capability) Register a capability
void	removeGroup(Group group) Removes a group from the list of groups

Methods inherited from class java.lang.Object

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

Constructor Detail

CapabilityServiceImpl

public CapabilityServiceImpl()

Method Detail

getCapability

public Capability getCapability(String name)

Description copied from interface: CapabilityService

Get a named capability.

Specified by:

getCapability in interface CapabilityService

Parameters:

name - capability name

Returns:

Capability capability or null if not found

See Also:

CapabilityService.getCapability(java.lang.String)

registerCapability

public void registerCapability(Capability capability)

Description copied from interface: CapabilityService

Register a capability

Specified by:

registerCapability in interface CapabilityService

Parameters:

capability - capability

See Also:

CapabilityService.registerCapability(org.alfresco.module.org_alfresco_module_rm.capability.Capability)

getCapabilities

public Set<Capability> getCapabilities()

Description copied from interface: CapabilityService

Get a list of all the assignable capabilities.

Specified by:

getCapabilities in interface CapabilityService

Returns:

Set<Capability> set of all the assignable capabilities

See Also:

CapabilityService.getCapabilities()

getCapabilities

public Set<Capability> getCapabilities(boolean includePrivate)

Description copied from interface: CapabilityService

Get a list of all the capabilities, optionally including those that are non-assignable.

Specified by:

getCapabilities in interface CapabilityService

Parameters:

includePrivate - indicates that the private, or non-assignable capabilities are included in the result

Returns:

Set<Capability> set of capabilities

See Also:

CapabilityService.getCapabilities(boolean)

getCapabilitiesAccessState

public Map<Capability,org.alfresco.service.cmr.security.AccessStatus> getCapabilitiesAccessState(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Description copied from interface: CapabilityService

Get all the capabilities access state based on the current user for the assignable capabilities.

Specified by:

getCapabilitiesAccessState in interface CapabilityService

Parameters:

nodeRef - node reference

Returns:

See Also:

CapabilityService.getCapabilitiesAccessState(org.alfresco.service.cmr.repository.NodeRef)

getCapabilitiesAccessState

public Map<Capability,org.alfresco.service.cmr.security.AccessStatus> getCapabilitiesAccessState(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                                                                                                 boolean includePrivate)

Description copied from interface: CapabilityService

Get all the capabilities access state based on the current user.

Specified by:

getCapabilitiesAccessState in interface CapabilityService

Parameters:

nodeRef - node reference

Returns:

See Also:

CapabilityService.getCapabilitiesAccessState(org.alfresco.service.cmr.repository.NodeRef, boolean)

getCapabilitiesAccessState

public Map<Capability,org.alfresco.service.cmr.security.AccessStatus> getCapabilitiesAccessState(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                                                                                                 List<String> capabilityNames)

Specified by:

getCapabilitiesAccessState in interface CapabilityService

Returns:

See Also:

CapabilityService.getCapabilitiesAccessState(org.alfresco.service.cmr.repository.NodeRef, java.util.List)

getCapabilityAccessState

public org.alfresco.service.cmr.security.AccessStatus getCapabilityAccessState(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                                                                               String capabilityName)

Description copied from interface: CapabilityService

Helper method to get the access state for a single capability.

Specified by:

getCapabilityAccessState in interface CapabilityService

Returns:

See Also:

CapabilityService.getCapabilityAccessState(org.alfresco.service.cmr.repository.NodeRef, java.lang.String)

getGroups

public List<Group> getGroups()

Description copied from interface: CapabilityService

Gets the list of all the capability groups (in index order)

Specified by:

getGroups in interface CapabilityService

Returns:

List<Group> List of all the capability groups (in index order)

See Also:

CapabilityService.getGroups()

getCapabilitiesByGroupId

public List<Capability> getCapabilitiesByGroupId(String groupId)

Description copied from interface: CapabilityService

Gets a list of capabilities for the given group id

Specified by:

getCapabilitiesByGroupId in interface CapabilityService

Parameters:

groupId - The id of a group for which the list of capabilities should be retrieved

Returns:

List<Capability> List of capabilities for the given group

See Also:

CapabilityService.getCapabilitiesByGroupId(java.lang.String)

getCapabilitiesByGroup

public List<Capability> getCapabilitiesByGroup(Group group)

Description copied from interface: CapabilityService

Get a list of capabilities for the given group

Specified by:

getCapabilitiesByGroup in interface CapabilityService

Parameters:

group - The group for which the list of capabilities should be retrieved

Returns:

List<Capability> List of capabilities for the given group

See Also:

CapabilityService.getCapabilitiesByGroup(org.alfresco.module.org_alfresco_module_rm.capability.Group)

getGroup

public Group getGroup(String groupId)

Description copied from interface: CapabilityService

Gets a group from it's id

Specified by:

getGroup in interface CapabilityService

Parameters:

groupId - The id of the group which should be retrieved

Returns:

Group The group with the id groupId

See Also:

CapabilityService.getGroup(java.lang.String)

addGroup

public void addGroup(Group group)

Description copied from interface: CapabilityService

Adds a group to the list of groups

Specified by:

addGroup in interface CapabilityService

Parameters:

group - The group which should be added

See Also:

CapabilityService.addGroup(org.alfresco.module.org_alfresco_module_rm.capability.Group)

removeGroup

public void removeGroup(Group group)

Description copied from interface: CapabilityService

Removes a group from the list of groups

Specified by:

removeGroup in interface CapabilityService

Parameters:

group - The group which should be removed

See Also:

CapabilityService.removeGroup(org.alfresco.module.org_alfresco_module_rm.capability.Group)

hasCapability

public boolean hasCapability(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                             String capabilityName)

Description copied from interface: CapabilityService

Check if the current user has the given capability.

Specified by:

hasCapability in interface CapabilityService

Returns:

See Also:

CapabilityService.hasCapability(org.alfresco.service.cmr.repository.NodeRef, java.lang.String)