18.01.2015 Views

Content Management Interoperability Services (CMIS) Version 1.1

Content Management Interoperability Services (CMIS) Version 1.1

Content Management Interoperability Services (CMIS) Version 1.1

SHOW MORE
SHOW LESS

Create successful ePaper yourself

Turn your PDF publications into a flip-book with our unique Google optimized e-Paper software.

2.2.4.17 deleteTree<br />

Description: Deletes the specified folder object and all of its child- and descendant-objects.<br />

Notes:<br />

• A repository MAY attempt to delete child- and descendant-objects of the specified folder in any order.<br />

• Any child- or descendant-object that the repository cannot delete MUST persist in a valid state in the<br />

<strong>CMIS</strong> domain model.<br />

• This service is not atomic.<br />

• However, if deletesinglefiled is chosen and some objects fail to delete, then single-filed objects<br />

are either deleted or kept, never just unfiled. This is so that a user can call this command again to<br />

recover from the error by using the same tree.<br />

2.2.4.17.1 Inputs<br />

Required:<br />

• Id repositoryId: The identifier for the repository.<br />

• Id folderId: The identifier of the folder to be deleted.<br />

Optional:<br />

• Boolean all<strong>Version</strong>s: If TRUE (default), then delete all versions of all documents. If FALSE,<br />

delete only the document versions referenced in the tree. The repository MUST ignore the value of this<br />

parameter when this service is invoked on any non-document objects or non-versionable document<br />

objects.<br />

• Enum unfileObjects: An enumeration specifying how the repository MUST process file-able<br />

child- or descendant-objects. Valid values are:<br />

unfile Unfile all fileable objects.<br />

deletesinglefiled Delete all fileable non-folder objects whose only parent-folders are in the current<br />

folder tree. Unfile all other fileable non-folder objects from the current folder tree.<br />

delete (default) Delete all fileable objects.<br />

• Boolean continueOnFailure: If TRUE, then the repository SHOULD continue attempting to perform<br />

this operation even if deletion of a child- or descendant-object in the specified folder cannot be<br />

deleted.<br />

If FALSE (default), then the repository SHOULD abort this method when it fails to delete a single child<br />

object or descendant object.<br />

2.2.4.17.2 Outputs<br />

• Id failedToDelete: A list of identifiers of objects in the folder tree that were not deleted.<br />

2.2.4.17.3 Exceptions Thrown & Conditions<br />

• See section 2.2.1.4.1 General Exceptions.<br />

• constraint If the method is invoked on a non-folder object.<br />

• updateConflict See section 2.2.1.4.2 Specific Exceptions.<br />

<strong>CMIS</strong>-v<strong>1.1</strong>-csprd01<br />

Standards Track Work Product<br />

Copyright © OASIS Open 2012. All Rights Reserved.<br />

18 August 2012<br />

Page 172 of 331

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!