org.apache.chemistry.opencmis.client.api

Interface FileableCmisObject

All Superinterfaces:

CmisObject, CmisObjectProperties, ObjectId

All Known Subinterfaces:

Document, Folder, Item, Policy

public interface FileableCmisObject
extends CmisObject

Fileable CMIS object. A fileable object is an object that can reside in a folder.

Method Summary

Modifier and Type	Method and Description
void	addToFolder(ObjectId folderId, boolean allVersions) Adds this object to a folder.
List<Folder>	getParents() Returns the parents of this object.
List<Folder>	getParents(OperationContext context) Returns the parents of this object.
List<String>	getPaths() Returns the paths of this object.
FileableCmisObject	move(ObjectId sourceFolderId, ObjectId targetFolderId) Moves this object.
FileableCmisObject	move(ObjectId sourceFolderId, ObjectId targetFolderId, OperationContext context) Moves this object.
void	removeFromFolder(ObjectId folderId) Removes this object from a folder.

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

Method Detail

move

FileableCmisObject move(ObjectId sourceFolderId,
                        ObjectId targetFolderId)

Moves this object.

Parameters:

sourceFolderId - the object ID of the source folder

targetFolderId - the object ID of the target folder

Returns:

the moved object

CMIS:

1.0

move

FileableCmisObject move(ObjectId sourceFolderId,
                        ObjectId targetFolderId,
                        OperationContext context)

Moves this object.

Parameters:

sourceFolderId - the object ID of the source folder

targetFolderId - the object ID of the target folder

context - the OperationContext to use to fetch the moved object

Returns:

the moved object

CMIS:

1.0

getParents

List<Folder> getParents()

Returns the parents of this object.

Returns:

the list of parent folders of this object or an empty list if this object is unfiled or if this object is the root folder

CMIS:

1.0

getParents

List<Folder> getParents(OperationContext context)

Returns the parents of this object.

Parameters:

context - the OperationContext to use to fetch the parent folder objects

Returns:

the list of parent folders of this object or an empty list if this object is unfiled or if this object is the root folder

CMIS:

1.0

getPaths

List<String> getPaths()

Returns the paths of this object.

Returns:

the list of paths of this object or an empty list if this object is unfiled or if this object is the root folder

CMIS:

1.0

addToFolder

void addToFolder(ObjectId folderId,
                 boolean allVersions)

Adds this object to a folder.

Parameters:

folderId - the object ID of the folder to which this object should be added

allVersions - if this parameter is true and this object is a document, all versions of the version series are added to the folder

CMIS:

1.0

removeFromFolder

void removeFromFolder(ObjectId folderId)

Removes this object from a folder.

Parameters:

folderId - the object ID of the folder from which this object should be removed

CMIS:

1.0