org.alfresco.cmis

Interface CMISServices

All Known Implementing Classes:

CMISServicesImpl

public interface CMISServices

CMIS Services.

Author:

davidc, dward

Field Summary

Fields

Modifier and Type	Field and Description
static String	ASSOC_ID_PREFIX The prefix we give to association object IDs.

Method Summary

Methods

Modifier and Type	Method and Description
void	addObjectToFolder(String objectId, String folderId) Adds a secondary child association to an object from a folder.
void	applyPolicy(String policyId, String objectId) Applies a policy object to a target object.
org.alfresco.service.cmr.repository.NodeRef	applyVersioningState(org.alfresco.service.cmr.repository.NodeRef source, CMISVersioningStateEnum versioningState) Applies a versioning state to a new node, potentially resulting in a new node.
void	cancelCheckOut(String objectId) Cancels check out of a private working copy.
org.alfresco.service.cmr.repository.NodeRef	checkIn(String objectId, String checkinComment, boolean isMajor) Checks in a private working copy.
org.alfresco.service.cmr.repository.NodeRef	checkOut(String objectId) Checks out an object.
String	createPolicy(Map<String,Serializable> properties, String folderId, List<String> policies) Creates a policy object of the specified type, and optionally adds the policy to a folder.
void	deleteContentStream(String objectId) Deletes a document's content stream.
void	deleteObject(String objectId, boolean allVersions) Deletes an object.
List<String>	deleteTree(String objectId, boolean continueOnFailure, boolean unfile, boolean deleteAllVersions) Deletes a folder and its children, without raising any exceptions.
void	deleteTreeReportLastError(String objectId, boolean continueOnFailure, boolean unfile, boolean deleteAllVersions) Deletes a folder and its children, raising an exception for the last error encountered.
List<org.alfresco.service.cmr.repository.NodeRef>	getAllVersions(String objectId) Gets all versions of an object.
List<CMISTypeDefinition>	getAppliedPolicies(String objectId, String filter) Gets the list of policy objects currently applied to a target object.
Set<CMISTypeDefinition>	getAspects(org.alfresco.service.cmr.repository.NodeRef nodeRef) Gets the aspects applied to a node.
Collection<CMISTypeDefinition>	getBaseTypes() Gets the CMIS base types.
org.alfresco.service.cmr.repository.NodeRef[]	getCheckedOut(String username, org.alfresco.service.cmr.repository.NodeRef folder, boolean includeDescendants, String orderBy) Query for checked out items
org.alfresco.query.PagingResults<FileInfo>	getChildren(org.alfresco.service.cmr.repository.NodeRef parent, CMISTypesFilterEnum typesFilter, BigInteger maxItems, BigInteger skipCount, String orderBy) Get node children
org.alfresco.service.cmr.repository.NodeRef[]	getChildren(org.alfresco.service.cmr.repository.NodeRef parent, CMISTypesFilterEnum typesFilter, String orderBy) Get node children
String	getCMISSpecTitle() Gets the supported CMIS Specification Title
String	getCMISVersion() Gets the supported CMIS Version
org.alfresco.service.cmr.repository.NodeRef	getDefaultRootNodeRef() Gets the default root node ref
String	getDefaultRootPath() Gets the default root node path
org.alfresco.service.cmr.repository.StoreRef	getDefaultRootStoreRef() Gets the default store ref
org.alfresco.service.cmr.repository.NodeRef	getFolder(String objectId) Gets a folder from an object ID.
org.alfresco.service.cmr.repository.NodeRef	getFolderParent(String folderId) Gets parent of a folder.
org.alfresco.service.cmr.repository.NodeRef	getLatestVersion(String objectId, boolean major) Gets the latest version of an object and optionally the latest major version.
org.alfresco.service.cmr.repository.NodeRef	getNode(String referenceType, String[] reference) Finds a NodeRef given a repository reference
<T> T	getObject(String objectId, Class<T> requiredType, boolean forUpdate, boolean isVersionable, boolean isPwc) Gets an object or a required type from an object ID.
Map<String,Serializable>	getProperties(org.alfresco.service.cmr.repository.AssociationRef assocRef) Get all properties of an association's type.
Map<String,Serializable>	getProperties(org.alfresco.service.cmr.repository.NodeRef nodeRef) Get all properties of a node's type.
Map<String,Serializable>	getProperties(org.alfresco.service.cmr.repository.NodeRef nodeRef, CMISTypeDefinition typeDef) Get all of a node's values for the properties in the given type or aspect.
Serializable	getProperty(org.alfresco.service.cmr.repository.AssociationRef assocRef, String propertyName) Get a single property for an association.
Serializable	getProperty(org.alfresco.service.cmr.repository.NodeRef nodeRef, CMISTypeDefinition typeDef, String propertyName) Get a single property, optionally constrained to a given node type or aspect
Serializable	getProperty(org.alfresco.service.cmr.repository.NodeRef nodeRef, String propertyName) Get a single property belonging to the node's type.
<T> T	getReadableObject(String objectId, Class<T> requiredType) Gets a readable object of a required type from an object ID.
org.alfresco.service.cmr.repository.AssociationRef[]	getRelationships(org.alfresco.service.cmr.repository.NodeRef node, CMISTypeDefinition relDef, boolean includeSubTypes, CMISRelationshipDirectionEnum direction) Query for relationships.
Map<String,Object>	getRenditions(org.alfresco.service.cmr.repository.NodeRef nodeRef, String renditionFilter) Gets a map of node attributes relating to renditions.
CMISTypeDefinition	getTypeDefinition(org.alfresco.service.cmr.repository.AssociationRef associationRef) Gets the type definition for an association.
CMISTypeDefinition	getTypeDefinition(org.alfresco.service.cmr.repository.NodeRef nodeRef) Gets the type definition for a node.
CMISTypeDefinition	getTypeDefinition(Object object) Gets the type definition for a given object.
CMISTypeDefinition	getTypeDefinition(String typeId) Gets the type definition for a given type ID.
<T> T	getVersionSeries(String objectId, Class<T> requiredType, boolean isVersionable) Gets the version series of an object.
void	moveObject(String objectId, String targetFolderId, String sourceFolderId) Moves an object from one folder to another.
void	removeObjectFromFolder(String objectId, String folderId) Removes a secondary child association to an object from a folder.
void	removePolicy(String policyId, String objectId) Removes a previously applied policy from a target object.
void	setAspects(org.alfresco.service.cmr.repository.NodeRef node, Iterable<String> aspectsToRemove, Iterable<String> aspectsToAdd) Sets the aspects on a node (Alfresco extension).
boolean	setContentStream(String objectId, org.alfresco.service.namespace.QName propertyQName, boolean overwriteFlag, InputStream contentStream, String mimeType) Sets the content stream on an object.
void	setProperty(org.alfresco.service.cmr.repository.NodeRef nodeRef, CMISTypeDefinition typeDef, String propertyName, Serializable value) Set a single property, optionally constrained to a given node type or aspect
void	setProperty(org.alfresco.service.cmr.repository.NodeRef nodeRef, String propertyName, Serializable value) Set a single property belonging to the node's type.

Field Detail

ASSOC_ID_PREFIX

static final String ASSOC_ID_PREFIX

The prefix we give to association object IDs.

See Also:

Constant Field Values

Method Detail

getCMISVersion

String getCMISVersion()

Gets the supported CMIS Version

Returns:

version of CMIS specification supported

getCMISSpecTitle

String getCMISSpecTitle()

Gets the supported CMIS Specification Title

Returns:

CMIS pecification Title

getDefaultRootPath

String getDefaultRootPath()

Gets the default root node path

Returns:

root node path

getDefaultRootNodeRef

org.alfresco.service.cmr.repository.NodeRef getDefaultRootNodeRef()

Gets the default root node ref

Returns:

root node ref

getDefaultRootStoreRef

org.alfresco.service.cmr.repository.StoreRef getDefaultRootStoreRef()

Gets the default store ref

Returns:

store ref

getNode

org.alfresco.service.cmr.repository.NodeRef getNode(String referenceType,
                                                  String[] reference)

Finds a NodeRef given a repository reference

Parameters:

referenceType - node, path

reference - node => id, path => path

Returns:

nodeRef (or null, if not found)

getRenditions

Map<String,Object> getRenditions(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                               String renditionFilter)
                                 throws CMISFilterNotValidException

Gets a map of node attributes relating to renditions.

Parameters:

nodeRef - the node ref

renditionFilter - the rendition filter

Returns:

the attribute map

Throws:

CMISFilterNotValidException - if the rendition filter is invalid

getChildren

org.alfresco.service.cmr.repository.NodeRef[] getChildren(org.alfresco.service.cmr.repository.NodeRef parent,
                                                        CMISTypesFilterEnum typesFilter,
                                                        String orderBy)
                                                          throws CMISInvalidArgumentException

Get node children

Parameters:

parent - parent node

typesFilter - types filter

orderBy - comma-separated list of sort names and the ascending modifier "ASC" or the descending modifier "DESC" for each sort name

Returns:

children of node

Throws:

CMISInvalidArgumentException

getChildren

org.alfresco.query.PagingResults<FileInfo> getChildren(org.alfresco.service.cmr.repository.NodeRef parent,
                                                     CMISTypesFilterEnum typesFilter,
                                                     BigInteger maxItems,
                                                     BigInteger skipCount,
                                                     String orderBy)
                                                       throws CMISInvalidArgumentException

Get node children

Parameters:

parent - parent node

typesFilter - types filter

maxItems - number of items (in page)

skipCount - number of items to skip (page starts at next item)

orderBy - comma-separated list of sort names and the ascending modifier "ASC" or the descending modifier "DESC" for each sort name

Returns:

children of node

Throws:

CMISInvalidArgumentException

getCheckedOut

org.alfresco.service.cmr.repository.NodeRef[] getCheckedOut(String username,
                                                          org.alfresco.service.cmr.repository.NodeRef folder,
                                                          boolean includeDescendants,
                                                          String orderBy)
                                                            throws CMISInvalidArgumentException

Query for checked out items

Parameters:

username - for user

folder - (optional) within folder

includeDescendants - true => include descendants of folder, false => only children of folder

orderBy - comma-separated list of query names and the ascending modifier "ASC" or the descending modifier "DESC" for each query name

Returns:

checked out items

Throws:

CMISInvalidArgumentException

getRelationships

org.alfresco.service.cmr.repository.AssociationRef[] getRelationships(org.alfresco.service.cmr.repository.NodeRef node,
                                                                    CMISTypeDefinition relDef,
                                                                    boolean includeSubTypes,
                                                                    CMISRelationshipDirectionEnum direction)
                                                                      throws CMISInvalidArgumentException

Query for relationships.

Parameters:

relDef - type of relationship to query (or null, for all relationships)

includeSubTypes - the include sub types

direction - limit direction of relationships to query (or null, for both directions)

node - the node

Returns:

relationships

Throws:

CMISInvalidArgumentException - if an argument is invalid

getProperty

Serializable getProperty(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                       String propertyName)
                         throws CMISInvalidArgumentException

Get a single property belonging to the node's type.

Parameters:

nodeRef - the node

propertyName - the property name

Returns:

value

Throws:

CMISInvalidArgumentException - if an argument is invalid

getProperty

Serializable getProperty(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                       CMISTypeDefinition typeDef,
                       String propertyName)
                         throws CMISInvalidArgumentException

Get a single property, optionally constrained to a given node type or aspect

Parameters:

nodeRef - the node

typeDef - the node type or aspect or null if any property can be returned

propertyName - the property name

Returns:

value

Throws:

CMISInvalidArgumentException - if an argument is invalid

getProperty

Serializable getProperty(org.alfresco.service.cmr.repository.AssociationRef assocRef,
                       String propertyName)
                         throws CMISInvalidArgumentException

Get a single property for an association.

Parameters:

assocRef - the association

propertyName - the property name

Returns:

value

Throws:

CMISInvalidArgumentException - if an argument is invalid

getProperties

Map<String,Serializable> getProperties(org.alfresco.service.cmr.repository.NodeRef nodeRef)
                                       throws CMISInvalidArgumentException

Get all properties of a node's type.

Parameters:

nodeRef - the node ref

Returns:

the properties

Throws:

CMISInvalidArgumentException - if an argument is invalid

getProperties

Map<String,Serializable> getProperties(org.alfresco.service.cmr.repository.AssociationRef assocRef)
                                       throws CMISInvalidArgumentException

Get all properties of an association's type.

Parameters:

assocRef - the association

Returns:

the properties

Throws:

CMISInvalidArgumentException - if an argument is invalid

getProperties

Map<String,Serializable> getProperties(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                                     CMISTypeDefinition typeDef)
                                       throws CMISInvalidArgumentException

Get all of a node's values for the properties in the given type or aspect.

Parameters:

nodeRef - the node ref

typeDef - the type or aspect definition

Returns:

the properties

Throws:

CMISInvalidArgumentException - if an argument is invalid

getAspects

Set<CMISTypeDefinition> getAspects(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Gets the aspects applied to a node.

Parameters:

nodeRef - the node ref

Returns:

the aspect definitions

Throws:

CMISInvalidArgumentException - if an argument is invalid

setProperty

void setProperty(org.alfresco.service.cmr.repository.NodeRef nodeRef,
               String propertyName,
               Serializable value)
                 throws CMISInvalidArgumentException,
                        CMISConstraintException

Set a single property belonging to the node's type.

Parameters:

nodeRef - the node ref

propertyName - the property name

value - the value

Throws:

CMISInvalidArgumentException - if an argument is invalid

CMISConstraintException - if the property cannot be set

setProperty

void setProperty(org.alfresco.service.cmr.repository.NodeRef nodeRef,
               CMISTypeDefinition typeDef,
               String propertyName,
               Serializable value)
                 throws CMISInvalidArgumentException,
                        CMISConstraintException

Set a single property, optionally constrained to a given node type or aspect

Parameters:

nodeRef - the node ref

typeDef - the node type or aspect or null if any valid property should be set (corresponding aspect added automatically).

propertyName - the property name

value - the value

Throws:

CMISInvalidArgumentException - if an argument is invalid

CMISConstraintException - if the property cannot be set

setAspects

void setAspects(org.alfresco.service.cmr.repository.NodeRef node,
              Iterable<String> aspectsToRemove,
              Iterable<String> aspectsToAdd)
                throws CMISInvalidArgumentException

Sets the aspects on a node (Alfresco extension).

Parameters:

node - the node

aspectsToRemove - the aspects to remove

aspectsToAdd - the aspects to add

Throws:

CMISInvalidArgumentException - if an argument is invalid

applyVersioningState

org.alfresco.service.cmr.repository.NodeRef applyVersioningState(org.alfresco.service.cmr.repository.NodeRef source,
                                                               CMISVersioningStateEnum versioningState)
                                                                 throws CMISConstraintException,
                                                                        CMISInvalidArgumentException

Applies a versioning state to a new node, potentially resulting in a new node.

Parameters:

source - the node

versioningState - the versioning state

Returns:

the node to write changes to

Throws:

CMISConstraintException - if it's not possible to apply the state

CMISInvalidArgumentException - if an argument is invalid

getReadableObject

<T> T getReadableObject(String objectId,
                      Class<T> requiredType)
                    throws CMISConstraintException,
                           CMISVersioningException,
                           CMISObjectNotFoundException,
                           CMISInvalidArgumentException,
                           CMISPermissionDeniedException

Gets a readable object of a required type from an object ID. The object may be immutable. Note that version history nodes can be returned as Versions or Nodes.

Parameters:

objectId - the object id

requiredType - the required type (NodeRef.class, Version.class, AssociationRef.class or Object.class)

Returns:

the readable object

Throws:

CMISConstraintException - if the object can't be returned as the right type

CMISVersioningException - if the object's versioning state isn't as expected

CMISObjectNotFoundException - if the object does not exist

CMISInvalidArgumentException - if an argument is invalid

CMISPermissionDeniedException - if access to the object is denied

getObject

<T> T getObject(String objectId,
              Class<T> requiredType,
              boolean forUpdate,
              boolean isVersionable,
              boolean isPwc)
            throws CMISConstraintException,
                   CMISVersioningException,
                   CMISObjectNotFoundException,
                   CMISInvalidArgumentException,
                   CMISPermissionDeniedException

Gets an object or a required type from an object ID. The object's mutability and versioning state will be validated as required.

Parameters:

objectId - the object id

requiredType - the required type (NodeRef.class, Version.class, AssociationRef.class or Object.class)

forUpdate - Do we require to write to this object? If true then the object must not be checked out and must not be a version history node unless the required type is assignable from Version.class.

isVersionable - Should the object be versionable?

isPwc - If isVersionable is true then the object should either be or not be a private working copy, as indicated by this flag

Returns:

the object

Throws:

CMISConstraintException - if the object can't be returned as the right type

CMISVersioningException - if the object's versioning state isn't as expected

CMISObjectNotFoundException - if the object does not exist

CMISInvalidArgumentException - if an argument is invalid

CMISPermissionDeniedException - if access to the object is denied

getVersionSeries

<T> T getVersionSeries(String objectId,
                     Class<T> requiredType,
                     boolean isVersionable)
                   throws CMISConstraintException,
                          CMISVersioningException,
                          CMISObjectNotFoundException,
                          CMISInvalidArgumentException,
                          CMISPermissionDeniedException

Gets the version series of an object.

Parameters:

objectId - the object id

requiredType - the required type (NodeRef.class, Version.class or AssociationRef.class)

isVersionable - Should the object be versionable?

Returns:

the version series

Throws:

CMISConstraintException - if the object can't be returned as the right type

CMISVersioningException - if the object's versioning state isn't as expected

CMISObjectNotFoundException - if the object does not exist

CMISInvalidArgumentException - if an argument is invalid

CMISPermissionDeniedException - if access to the object is denied

getFolder

org.alfresco.service.cmr.repository.NodeRef getFolder(String objectId)
                                                      throws CMISConstraintException,
                                                             CMISVersioningException,
                                                             CMISObjectNotFoundException,
                                                             CMISInvalidArgumentException,
                                                             CMISPermissionDeniedException

Gets a folder from an object ID.

Parameters:

objectId - the object id

Returns:

the folder

Throws:

CMISConstraintException - if the object can't be returned as the right type

CMISVersioningException - if the object's versioning state isn't as expected

CMISObjectNotFoundException - if the object does not exist

CMISInvalidArgumentException - if an argument is invalid

CMISPermissionDeniedException - if access to the object is denied

getFolderParent

org.alfresco.service.cmr.repository.NodeRef getFolderParent(String folderId)
                                                            throws CMISConstraintException,
                                                                   CMISVersioningException,
                                                                   CMISObjectNotFoundException,
                                                                   CMISInvalidArgumentException,
                                                                   CMISPermissionDeniedException

Gets parent of a folder.

Parameters:

folderId - the folder id

Returns:

the folder parent

Throws:

CMISConstraintException - if the object can't be returned as the right type

CMISVersioningException - if the object's versioning state isn't as expected

CMISObjectNotFoundException - if the object does not exist

CMISInvalidArgumentException - if an argument is invalid

CMISPermissionDeniedException - if access to the object is denied

getTypeDefinition

CMISTypeDefinition getTypeDefinition(org.alfresco.service.cmr.repository.NodeRef nodeRef)
                                     throws CMISInvalidArgumentException

Gets the type definition for a node.

Parameters:

nodeRef - the node

Returns:

the type definition

Throws:

CMISInvalidArgumentException - if an argument is invalid

getTypeDefinition

CMISTypeDefinition getTypeDefinition(org.alfresco.service.cmr.repository.AssociationRef associationRef)
                                     throws CMISInvalidArgumentException

Gets the type definition for an association.

Parameters:

associationRef - the association

Returns:

the type definition

Throws:

CMISInvalidArgumentException - if an argument is invalid

getTypeDefinition

CMISTypeDefinition getTypeDefinition(String typeId)
                                     throws CMISInvalidArgumentException

Gets the type definition for a given type ID.

Parameters:

typeId - the type id

Returns:

the type definition

Throws:

CMISInvalidArgumentException - if an argument is invalid

getTypeDefinition

CMISTypeDefinition getTypeDefinition(Object object)
                                     throws CMISInvalidArgumentException

Gets the type definition for a given object.

Parameters:

object - the object

Returns:

the type definition

Throws:

CMISInvalidArgumentException - if an argument is invalid

getBaseTypes

Collection<CMISTypeDefinition> getBaseTypes()

Gets the CMIS base types.

Returns:

the base types

checkOut

org.alfresco.service.cmr.repository.NodeRef checkOut(String objectId)
                                                     throws CMISConstraintException,
                                                            CMISVersioningException,
                                                            CMISObjectNotFoundException,
                                                            CMISInvalidArgumentException,
                                                            CMISPermissionDeniedException

Checks out an object.

Parameters:

objectId - the object id

Returns:

the resulting private working copy node

Throws:

CMISConstraintException - if the object isn't of the right type

CMISVersioningException - if the object's versioning state isn't as expected

CMISObjectNotFoundException - if the object does not exist

CMISInvalidArgumentException - if an argument is invalid

CMISPermissionDeniedException - if access to the object is denied

checkIn

org.alfresco.service.cmr.repository.NodeRef checkIn(String objectId,
                                                  String checkinComment,
                                                  boolean isMajor)
                                                    throws CMISConstraintException,
                                                           CMISVersioningException,
                                                           CMISObjectNotFoundException,
                                                           CMISInvalidArgumentException,
                                                           CMISPermissionDeniedException

Checks in a private working copy.

Parameters:

objectId - the object id of the private working copy

checkinComment - the checkin comment

isMajor - Is this a major version?

Returns:

the checked in node

Throws:

CMISConstraintException - if the object isn't of the right type

CMISVersioningException - if the object's versioning state isn't as expected

CMISObjectNotFoundException - if the object does not exist

CMISInvalidArgumentException - if an argument is invalid

CMISPermissionDeniedException - if access to the object is denied

cancelCheckOut

void cancelCheckOut(String objectId)
                    throws CMISConstraintException,
                           CMISVersioningException,
                           CMISObjectNotFoundException,
                           CMISInvalidArgumentException,
                           CMISPermissionDeniedException

Cancels check out of a private working copy.

Parameters:

objectId - the object id of the private working copy

Throws:

CMISConstraintException - if the object isn't of the right type

CMISVersioningException - if the object's versioning state isn't as expected

CMISObjectNotFoundException - if the object does not exist

CMISInvalidArgumentException - if an argument is invalid

CMISPermissionDeniedException - if access to the object is denied

getAllVersions

List<org.alfresco.service.cmr.repository.NodeRef> getAllVersions(String objectId)
                                                                 throws CMISConstraintException,
                                                                        CMISVersioningException,
                                                                        CMISObjectNotFoundException,
                                                                        CMISInvalidArgumentException,
                                                                        CMISPermissionDeniedException

Gets all versions of an object.

Parameters:

objectId - the object id

Returns:

the all versions

Throws:

CMISConstraintException - if the object isn't of the right type

CMISVersioningException - if the object's versioning state isn't as expected

CMISObjectNotFoundException - if the object does not exist

CMISInvalidArgumentException - if an argument is invalid

CMISPermissionDeniedException - if access to the object is denied

getLatestVersion

org.alfresco.service.cmr.repository.NodeRef getLatestVersion(String objectId,
                                                           boolean major)
                                                             throws CMISConstraintException,
                                                                    CMISVersioningException,
                                                                    CMISObjectNotFoundException,
                                                                    CMISInvalidArgumentException,
                                                                    CMISPermissionDeniedException

Gets the latest version of an object and optionally the latest major version.

Parameters:

objectId - the object id

major - Should we return the latest major version?

Returns:

the latest version

Throws:

CMISConstraintException - if the object isn't of the right type

CMISVersioningException - if the object's versioning state isn't as expected

CMISObjectNotFoundException - if the object does not exist

CMISInvalidArgumentException - if an argument is invalid

CMISPermissionDeniedException - if access to the object is denied

deleteTree

List<String> deleteTree(String objectId,
                      boolean continueOnFailure,
                      boolean unfile,
                      boolean deleteAllVersions)
                        throws CMISConstraintException,
                               CMISVersioningException,
                               CMISObjectNotFoundException,
                               CMISInvalidArgumentException,
                               CMISPermissionDeniedException

Deletes a folder and its children, without raising any exceptions.

Parameters:

objectId - the folder's object id

continueOnFailure - should we continue if an error occurs with one of the children?

unfile - should we remove non-primary associations to nodes rather than delete them?

deleteAllVersions - should we delete all the versions of the documents we delete?

Returns:

list of object IDs of the children we failed to delete

Throws:

CMISConstraintException - if the object isn't of the right type

CMISVersioningException - if the object's versioning state isn't as expected

CMISObjectNotFoundException - if the object does not exist

CMISInvalidArgumentException - if an argument is invalid

CMISPermissionDeniedException - if access to the object is denied

deleteTreeReportLastError

void deleteTreeReportLastError(String objectId,
                             boolean continueOnFailure,
                             boolean unfile,
                             boolean deleteAllVersions)
                               throws CMISServiceException

Deletes a folder and its children, raising an exception for the last error encountered.

Parameters:

objectId - the folder's object id

continueOnFailure - should we continue if an error occurs with one of the children?

unfile - should we remove non-primary associations to nodes rather than delete them?

deleteAllVersions - should we delete all the versions of the nodes we delete?

Throws:

CMISServiceException - the last error encountered

deleteContentStream

void deleteContentStream(String objectId)
                         throws CMISConstraintException,
                                CMISVersioningException,
                                CMISObjectNotFoundException,
                                CMISInvalidArgumentException,
                                CMISPermissionDeniedException

Deletes a document's content stream.

Parameters:

objectId - the object id of the document

Throws:

CMISConstraintException - if the object isn't of the right type

CMISVersioningException - if the object's versioning state isn't as expected

CMISObjectNotFoundException - if the object does not exist

CMISInvalidArgumentException - if an argument is invalid

CMISPermissionDeniedException - if access to the object is denied

deleteObject

void deleteObject(String objectId,
                boolean allVersions)
                  throws CMISConstraintException,
                         CMISVersioningException,
                         CMISObjectNotFoundException,
                         CMISInvalidArgumentException,
                         CMISPermissionDeniedException,
                         CMISRuntimeException,
                         CMISServiceException

Deletes an object.

Parameters:

objectId - the object id

allVersions - if the object is a document, should we delete all versions?

Throws:

CMISConstraintException - if the object isn't of the right type

CMISVersioningException - if the object's versioning state isn't as expected

CMISObjectNotFoundException - if the object does not exist

CMISInvalidArgumentException - if an argument is invalid

CMISPermissionDeniedException - if access to the object is denied

CMISRuntimeException - on other exceptions

CMISServiceException

addObjectToFolder

void addObjectToFolder(String objectId,
                     String folderId)
                       throws CMISConstraintException,
                              CMISVersioningException,
                              CMISObjectNotFoundException,
                              CMISInvalidArgumentException,
                              CMISPermissionDeniedException

Adds a secondary child association to an object from a folder.

Parameters:

objectId - the object id

folderId - the folder id

Throws:

CMISConstraintException - if an object isn't of the right type

CMISVersioningException - if an object's versioning state isn't as expected

CMISObjectNotFoundException - if an object does not exist

CMISInvalidArgumentException - if an argument is invalid

CMISPermissionDeniedException - if access to an object is denied

removeObjectFromFolder

void removeObjectFromFolder(String objectId,
                          String folderId)
                            throws CMISNotSupportedException,
                                   CMISConstraintException,
                                   CMISVersioningException,
                                   CMISObjectNotFoundException,
                                   CMISInvalidArgumentException,
                                   CMISPermissionDeniedException

Removes a secondary child association to an object from a folder.

Parameters:

objectId - the object id

folderId - the folder id

Throws:

CMISNotSupportedException - if the child association is primary

CMISConstraintException - if an object isn't of the right type

CMISVersioningException - if an object's versioning state isn't as expected

CMISObjectNotFoundException - if an object does not exist

CMISInvalidArgumentException - if an argument is invalid

CMISPermissionDeniedException - if access to an object is denied

moveObject

void moveObject(String objectId,
              String targetFolderId,
              String sourceFolderId)
                throws CMISConstraintException,
                       CMISVersioningException,
                       CMISObjectNotFoundException,
                       CMISInvalidArgumentException,
                       CMISPermissionDeniedException

Moves an object from one folder to another.

Parameters:

objectId - the object id

targetFolderId - the target folder id

sourceFolderId - the source folder id

Throws:

CMISConstraintException - if an object isn't of the right type

CMISVersioningException - if an object's versioning state isn't as expected

CMISObjectNotFoundException - if an object does not exist

CMISInvalidArgumentException - if an argument is invalid

CMISPermissionDeniedException - if access to an object is denied

setContentStream

boolean setContentStream(String objectId,
                       org.alfresco.service.namespace.QName propertyQName,
                       boolean overwriteFlag,
                       InputStream contentStream,
                       String mimeType)
                         throws CMISConstraintException,
                                CMISVersioningException,
                                CMISObjectNotFoundException,
                                CMISContentAlreadyExistsException,
                                CMISStreamNotSupportedException,
                                CMISInvalidArgumentException,
                                CMISPermissionDeniedException

Sets the content stream on an object.

Parameters:

objectId - the object id

propertyQName - the property q name

overwriteFlag - the overwrite flag

contentStream - the content stream

mimeType - the mime type

Returns:

true if content was overwritten

Throws:

CMISContentAlreadyExistsException - if overwrite was false and content already existed

CMISStreamNotSupportedException - if the object's type definition does not allow a content stream

CMISConstraintException - if an object isn't of the right type

CMISVersioningException - if an object's versioning state isn't as expected

CMISObjectNotFoundException - if an object does not exist

CMISInvalidArgumentException - if an argument is invalid

CMISPermissionDeniedException - if access to an object is denied

createPolicy

String createPolicy(Map<String,Serializable> properties,
                  String folderId,
                  List<String> policies)
                    throws CMISConstraintException,
                           CMISRuntimeException,
                           CMISInvalidArgumentException

Creates a policy object of the specified type, and optionally adds the policy to a folder. Currently no policy types can be created in Alfresco.

Parameters:

properties - CMIS properties

folderId - parent folder for this new policy

policies - the policies

Returns:

Id of the created policy object

Throws:

CMISConstraintException - if there is a problem with the supplied properties

CMISInvalidArgumentException - if an argument is invalid

CMISRuntimeException - on other exceptions

applyPolicy

void applyPolicy(String policyId,
               String objectId)
                 throws CMISConstraintException,
                        CMISVersioningException,
                        CMISObjectNotFoundException,
                        CMISInvalidArgumentException,
                        CMISPermissionDeniedException

Applies a policy object to a target object.

Parameters:

policyId - policy Id

objectId - target object Id

Throws:

CMISConstraintException - if an object isn't of the right type

CMISVersioningException - if an object's versioning state isn't as expected

CMISObjectNotFoundException - if an object does not exist

CMISInvalidArgumentException - if an argument is invalid

CMISPermissionDeniedException - if access to an object is denied

getAppliedPolicies

List<CMISTypeDefinition> getAppliedPolicies(String objectId,
                                          String filter)
                                            throws CMISConstraintException,
                                                   CMISVersioningException,
                                                   CMISObjectNotFoundException,
                                                   CMISInvalidArgumentException,
                                                   CMISPermissionDeniedException,
                                                   CMISFilterNotValidException

Gets the list of policy objects currently applied to a target object.

Parameters:

objectId - the object id

filter - property filter

Returns:

the applied policies

Throws:

CMISConstraintException - if an object isn't of the right type

CMISVersioningException - if an object's versioning state isn't as expected

CMISObjectNotFoundException - if an object does not exist

CMISInvalidArgumentException - if an argument is invalid

CMISPermissionDeniedException - if access to an object is denied

CMISFilterNotValidException - if the property filter is invalid

removePolicy

void removePolicy(String policyId,
                String objectId)
                  throws CMISConstraintException,
                         CMISVersioningException,
                         CMISObjectNotFoundException,
                         CMISInvalidArgumentException,
                         CMISPermissionDeniedException

Removes a previously applied policy from a target object. The policy object is not deleted, and may still be applied to other objects.

Parameters:

policyId - policy Id

objectId - target object Id.

Throws:

CMISConstraintException - if an object isn't of the right type

CMISVersioningException - if an object's versioning state isn't as expected

CMISObjectNotFoundException - if an object does not exist

CMISInvalidArgumentException - if an argument is invalid

CMISPermissionDeniedException - if access to an object is denied