org.apache.chemistry.opencmis.client.api
Interface Folder

All Superinterfaces:
CmisObject, CmisObjectProperties, FileableCmisObject, FolderProperties, ObjectId

public interface Folder
extends FileableCmisObject, FolderProperties

CMIS Folder.

See Domain Model 2.5


Method Summary
 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.
 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.
 String getPath()
          Returns the path of the folder.
 TransientFolder getTransientFolder()
           
 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, delete, getAcl, getAdapter, getAllowableActions, getExtensions, getPolicies, getRefreshTimestamp, getRelationships, getRenditions, getTransientObject, refresh, refreshIfOld, removeAcl, removePolicy, 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
getBaseType, getBaseTypeId, getChangeToken, getCreatedBy, getCreationDate, getLastModificationDate, getLastModifiedBy, getName, getProperties, getProperty, getPropertyValue, getType
 
Methods inherited from interface org.apache.chemistry.opencmis.client.api.FolderProperties
getAllowedChildObjectTypes, getParentId
 

Method Detail

getTransientFolder

TransientFolder getTransientFolder()

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.

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

createDocument

Document createDocument(Map<String,?> properties,
                        ContentStream contentStream,
                        VersioningState versioningState)
Creates a new document in this folder.

Returns:
the new document object

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

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

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

createFolder

Folder createFolder(Map<String,?> properties)
Creates a new subfolder in this folder.

Returns:
the new folder object

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

createPolicy

Policy createPolicy(Map<String,?> properties)
Creates a new policy in this folder.

Returns:
the new policy object

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

getFolderTree

List<Tree<FileableCmisObject>> getFolderTree(int depth)
Gets the folder tree starting with this folder.


getFolderTree

List<Tree<FileableCmisObject>> getFolderTree(int depth,
                                             OperationContext context)
Gets the folder tree starting with this folder using the given OperationContext.


getDescendants

List<Tree<FileableCmisObject>> getDescendants(int depth)
Gets the folder descendants starting with this folder.


getDescendants

List<Tree<FileableCmisObject>> getDescendants(int depth,
                                              OperationContext context)
Gets the folder descendants starting with this folder using the given OperationContext.


getChildren

ItemIterable<CmisObject> getChildren()
Returns the children of this folder.


getChildren

ItemIterable<CmisObject> getChildren(OperationContext context)
Returns the children of this folder using the given OperationContext.


isRootFolder

boolean isRootFolder()
Returns if the folder is the root folder.


getFolderParent

Folder getFolderParent()
Gets the parent folder object

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

getPath

String getPath()
Returns the path of the folder.


getCheckedOutDocs

ItemIterable<Document> getCheckedOutDocs()
Returns all checked out documents in this folder.


getCheckedOutDocs

ItemIterable<Document> getCheckedOutDocs(OperationContext context)
Returns all checked out documents in this folder using the given OperationContext.



Copyright © 2009-2012 The Apache Software Foundation. All Rights Reserved.