org.apache.chemistry.opencmis.client.api

Interface Folder

All Superinterfaces:

CmisObject, CmisObjectProperties, FileableCmisObject, FolderProperties, ObjectId

public interface Folder
extends FileableCmisObject, FolderProperties

CMIS folder interface.

CMIS:

1.0

Method Summary

Modifier and Type	Method and Description
Document	createDocument(Map<String,?> properties, ContentStream contentStream, VersioningState versioningState) Creates a new document in this folder.
Document	createDocument(Map<String,?> properties, ContentStream contentStream, VersioningState versioningState, List<Policy> policies, List<Ace> addAces, List<Ace> removeAces, OperationContext context) Creates a new document in this folder.
Document	createDocumentFromSource(ObjectId source, Map<String,?> properties, VersioningState versioningState) Creates a new document from a source document in this folder.
Document	createDocumentFromSource(ObjectId source, Map<String,?> properties, VersioningState versioningState, List<Policy> policies, List<Ace> addAces, List<Ace> removeAces, OperationContext context) Creates a new document from a source document in this folder.
Folder	createFolder(Map<String,?> properties) Creates a new subfolder in this folder.
Folder	createFolder(Map<String,?> properties, List<Policy> policies, List<Ace> addAces, List<Ace> removeAces, OperationContext context) Creates a new subfolder in this folder.
Item	createItem(Map<String,?> properties) Creates a new item in this folder.
Item	createItem(Map<String,?> properties, List<Policy> policies, List<Ace> addAces, List<Ace> removeAces, OperationContext context) Creates a new item in this folder.
Policy	createPolicy(Map<String,?> properties) Creates a new policy in this folder.
Policy	createPolicy(Map<String,?> properties, List<Policy> policies, List<Ace> addAces, List<Ace> removeAces, OperationContext context) Creates a new policy in this folder.
List<String>	deleteTree(boolean allversions, UnfileObject unfile, boolean continueOnFailure) Deletes this folder and all subfolders.
ItemIterable<Document>	getCheckedOutDocs() Returns all checked out documents in this folder.
ItemIterable<Document>	getCheckedOutDocs(OperationContext context) Returns all checked out documents in this folder using the given OperationContext.
ItemIterable<CmisObject>	getChildren() Returns the children of this folder.
ItemIterable<CmisObject>	getChildren(OperationContext context) Returns the children of this folder using the given OperationContext.
List<Tree<FileableCmisObject>>	getDescendants(int depth) Gets the folder descendants starting with this folder.
List<Tree<FileableCmisObject>>	getDescendants(int depth, OperationContext context) Gets the folder descendants starting with this folder using the given OperationContext.
Folder	getFolderParent() Gets the parent folder object.
List<Tree<FileableCmisObject>>	getFolderTree(int depth) Gets the folder tree starting with this folder.
List<Tree<FileableCmisObject>>	getFolderTree(int depth, OperationContext context) Gets the folder tree starting with this folder using the given OperationContext.
FolderType	getFolderType() Returns the object type as a folder type.
String	getPath() Returns the path of the folder.
boolean	isRootFolder() Returns if the folder is the root folder.

Methods inherited from interface org.apache.chemistry.opencmis.client.api.FileableCmisObject

addToFolder, getParents, getParents, getPaths, move, move, removeFromFolder

Methods inherited from interface org.apache.chemistry.opencmis.client.api.CmisObject

addAcl, applyAcl, applyPolicy, applyPolicy, delete, delete, getAcl, getAdapter, getAllowableActions, getExtensions, getPermissionsForPrincipal, getPolicies, getPolicyIds, getRefreshTimestamp, getRelationships, getRenditions, hasAllowableAction, refresh, refreshIfOld, removeAcl, removePolicy, removePolicy, rename, rename, setAcl, updateProperties, updateProperties, updateProperties, updateProperties

Methods inherited from interface org.apache.chemistry.opencmis.client.api.ObjectId

getId

Methods inherited from interface org.apache.chemistry.opencmis.client.api.CmisObjectProperties

findObjectType, getBaseType, getBaseTypeId, getChangeToken, getCreatedBy, getCreationDate, getDescription, getLastModificationDate, getLastModifiedBy, getName, getProperties, getProperty, getPropertyValue, getSecondaryTypes, getType

Methods inherited from interface org.apache.chemistry.opencmis.client.api.FolderProperties

getAllowedChildObjectTypes, getParentId

Method Detail

getFolderType

FolderType getFolderType()

Returns the object type as a folder type.

Returns:

the folder type

Throws:

ClassCastException - if the object type is not a folder type

CMIS:

1.0

createDocument

Document createDocument(Map<String,?> properties,
                        ContentStream contentStream,
                        VersioningState versioningState,
                        List<Policy> policies,
                        List<Ace> addAces,
                        List<Ace> removeAces,
                        OperationContext context)

Creates a new document in this folder. The stream in contentStream is consumed but not closed by this method.

Returns:

the new document object or null if the parameter context was set to null

CMIS:

1.0

createDocument

Document createDocument(Map<String,?> properties,
                        ContentStream contentStream,
                        VersioningState versioningState)

Creates a new document in this folder. The stream in contentStream is consumed but not closed by this method.

Returns:

the new document object

CMIS:

1.0

createDocumentFromSource

Document createDocumentFromSource(ObjectId source,
                                  Map<String,?> properties,
                                  VersioningState versioningState,
                                  List<Policy> policies,
                                  List<Ace> addAces,
                                  List<Ace> removeAces,
                                  OperationContext context)

Creates a new document from a source document in this folder.

Returns:

the new document object or null if the parameter context was set to null

CMIS:

1.0

createDocumentFromSource

Document createDocumentFromSource(ObjectId source,
                                  Map<String,?> properties,
                                  VersioningState versioningState)

Creates a new document from a source document in this folder.

Returns:

the new document object

CMIS:

1.0

createFolder

Folder createFolder(Map<String,?> properties,
                    List<Policy> policies,
                    List<Ace> addAces,
                    List<Ace> removeAces,
                    OperationContext context)

Creates a new subfolder in this folder.

Returns:

the new folder object or null if the parameter context was set to null

CMIS:

1.0

createFolder

Folder createFolder(Map<String,?> properties)

Creates a new subfolder in this folder.

Returns:

the new folder object

CMIS:

1.0

createPolicy

Policy createPolicy(Map<String,?> properties,
                    List<Policy> policies,
                    List<Ace> addAces,
                    List<Ace> removeAces,
                    OperationContext context)

Creates a new policy in this folder.

Returns:

the new policy object or null if the parameter context was set to null

CMIS:

1.0

createItem

Item createItem(Map<String,?> properties)

Creates a new item in this folder.

Returns:

the new item object

CMIS:

1.1

createItem

Item createItem(Map<String,?> properties,
                List<Policy> policies,
                List<Ace> addAces,
                List<Ace> removeAces,
                OperationContext context)

Creates a new item in this folder.

Returns:

the new item object or null if the parameter context was set to null

CMIS:

1.1

createPolicy

Policy createPolicy(Map<String,?> properties)

Creates a new policy in this folder.

Returns:

the new policy object

CMIS:

1.0

deleteTree

List<String> deleteTree(boolean allversions,
                        UnfileObject unfile,
                        boolean continueOnFailure)

Deletes this folder and all subfolders.

Returns:

a list of object IDs which failed to be deleted

CMIS:

1.0

getFolderTree

List<Tree<FileableCmisObject>> getFolderTree(int depth)

Gets the folder tree starting with this folder.

CMIS:

1.0

getFolderTree

List<Tree<FileableCmisObject>> getFolderTree(int depth,
                                             OperationContext context)

Gets the folder tree starting with this folder using the given OperationContext.

CMIS:

1.0

getDescendants

List<Tree<FileableCmisObject>> getDescendants(int depth)

Gets the folder descendants starting with this folder.

CMIS:

1.0

getDescendants

List<Tree<FileableCmisObject>> getDescendants(int depth,
                                              OperationContext context)

Gets the folder descendants starting with this folder using the given OperationContext.

CMIS:

1.0

getChildren

ItemIterable<CmisObject> getChildren()

Returns the children of this folder.

CMIS:

1.0

getChildren

ItemIterable<CmisObject> getChildren(OperationContext context)

Returns the children of this folder using the given OperationContext.

CMIS:

1.0

isRootFolder

boolean isRootFolder()

Returns if the folder is the root folder.

Returns:

true if the folder is the root folder, false otherwise

CMIS:

1.0

getFolderParent

Folder getFolderParent()

Gets the parent folder object.

Returns:

the parent folder object or null if the folder is the root folder.

CMIS:

1.0

getPath

String getPath()

Returns the path of the folder.

Returns:

the absolute folder path

CMIS:

1.0

getCheckedOutDocs

ItemIterable<Document> getCheckedOutDocs()

Returns all checked out documents in this folder.

CMIS:

1.0

getCheckedOutDocs

ItemIterable<Document> getCheckedOutDocs(OperationContext context)

Returns all checked out documents in this folder using the given OperationContext.

CMIS:

1.0