org.apache.chemistry.opencmis.commons.spi

Interface PolicyService

All Known Subinterfaces:

CallContextAwareCmisService, CmisService, ProgressControlCmisService

All Known Implementing Classes:

AbstractBindingCmisServiceWrapper, AbstractCmisService, AbstractCmisServiceWrapper, CachedBindingCmisService, ConformanceCmisServiceWrapper, FilterCmisService, HttpSessionCmisService, LruCacheCmisService, SimpleForwardingCmisService, SimpleLoggingCmisServiceWrapper

public interface PolicyService

Policy Service interface.

See the CMIS 1.0 and CMIS 1.1 specifications for details on the operations, parameters, exceptions and the domain model.

Method Summary

Modifier and Type	Method and Description
void	applyPolicy(String repositoryId, String policyId, String objectId, ExtensionsData extension) Applies a specified policy to an object.
List<ObjectData>	getAppliedPolicies(String repositoryId, String objectId, String filter, ExtensionsData extension) Gets the list of policies currently applied to the specified object.
void	removePolicy(String repositoryId, String policyId, String objectId, ExtensionsData extension) Removes a specified policy from an object.

Method Detail

applyPolicy

void applyPolicy(String repositoryId,
                 String policyId,
                 String objectId,
                 ExtensionsData extension)

Applies a specified policy to an object.

Parameters:

repositoryId - the identifier for the repository

policyId - the policy to add

objectId - the object

extension - extension data

removePolicy

void removePolicy(String repositoryId,
                  String policyId,
                  String objectId,
                  ExtensionsData extension)

Removes a specified policy from an object.

Parameters:

repositoryId - the identifier for the repository

policyId - the policy to remove

objectId - the object

extension - extension data

getAppliedPolicies

List<ObjectData> getAppliedPolicies(String repositoryId,
                                    String objectId,
                                    String filter,
                                    ExtensionsData extension)

Gets the list of policies currently applied to the specified object.

Parameters:

repositoryId - the identifier for the repository

objectId - the object

filter - (optional) a comma-separated list of query names that defines which properties must be returned by the repository (default is repository specific)

extension - extension data

Returns:

the list of applied policies