org.apache.chemistry.opencmis.client.api

Interface Document

All Superinterfaces:

CmisObject, CmisObjectProperties, DocumentProperties, FileableCmisObject, ObjectId

public interface Document
extends FileableCmisObject, DocumentProperties

CMIS document interface.

CMIS:

1.0

Method Summary

Modifier and Type	Method and Description
Document	appendContentStream(ContentStream contentStream, boolean isLastChunk) Appends a content stream to the content stream of the document and refreshes this object afterwards.
ObjectId	appendContentStream(ContentStream contentStream, boolean isLastChunk, boolean refresh) Appends a content stream to the content stream of the document.
void	cancelCheckOut() If this is a PWC (private working copy) the check out will be reversed.
ObjectId	checkIn(boolean major, Map<String,?> properties, ContentStream contentStream, String checkinComment) If this is a PWC (private working copy) it performs a check in.
ObjectId	checkIn(boolean major, Map<String,?> properties, ContentStream contentStream, String checkinComment, List<Policy> policies, List<Ace> addAces, List<Ace> removeAces) If this is a PWC (private working copy) it performs a check in.
ObjectId	checkOut() Checks out the document and returns the object ID of the PWC (private working copy).
Document	copy(ObjectId targetFolderId) Creates a copy of this document, including content.
Document	copy(ObjectId targetFolderId, Map<String,?> properties, VersioningState versioningState, List<Policy> policies, List<Ace> addACEs, List<Ace> removeACEs, OperationContext context) Creates a copy of this document, including content.
OutputStream	createAppendOutputStream() Creates an OutputStream stream object that can be used to append content the current content of the document.
OutputStream	createAppendOutputStream(int bufferSize) Creates an OutputStream stream object that can be used to append content the current content of the document.
OutputStream	createOverwriteOutputStream(String filename, String mimeType) Creates an OutputStream stream object that can be used to overwrite the current content of the document.
OutputStream	createOverwriteOutputStream(String filename, String mimeType, int bufferSize) Creates an OutputStream stream object that can be used to overwrite the current content of the document.
void	deleteAllVersions() Deletes this document and all its versions.
Document	deleteContentStream() Removes the current content stream from the document and refreshes this object afterwards.
ObjectId	deleteContentStream(boolean refresh) Removes the current content stream from the document.
List<Document>	getAllVersions() Fetches all versions of this document.
List<Document>	getAllVersions(OperationContext context) Fetches all versions of this document using the given OperationContext.
ContentStream	getContentStream() Retrieves the content stream of this document.
ContentStream	getContentStream(BigInteger offset, BigInteger length) Retrieves the content stream of this document.
ContentStream	getContentStream(String streamId) Retrieves the content stream that is associated with the given stream ID.
ContentStream	getContentStream(String streamId, BigInteger offset, BigInteger length) Retrieves the content stream that is associated with the given stream ID.
String	getContentUrl() Returns the content URL of the document if the binding supports content URLs.
String	getContentUrl(String streamId) Returns the content URL of the document or a rendition if the binding supports content URLs.
DocumentType	getDocumentType() Returns the object type as a document type.
Document	getObjectOfLatestVersion(boolean major) Fetches the latest major or minor version of this document.
Document	getObjectOfLatestVersion(boolean major, OperationContext context) Fetches the latest major or minor version of this document using the given OperationContext.
boolean	isVersionable() Returns whether the document is versionable or not.
Boolean	isVersionSeriesPrivateWorkingCopy() Determines whether this document is the PWC in the version series or not.
Document	setContentStream(ContentStream contentStream, boolean overwrite) Sets a new content stream for the document and refreshes this object afterwards.
ObjectId	setContentStream(ContentStream contentStream, boolean overwrite, boolean refresh) Sets a new content stream for the document.

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.DocumentProperties

getCheckinComment, getContentStreamFileName, getContentStreamHashes, getContentStreamId, getContentStreamLength, getContentStreamMimeType, getLatestAccessibleStateId, getVersionLabel, getVersionSeriesCheckedOutBy, getVersionSeriesCheckedOutId, getVersionSeriesId, isImmutable, isLatestMajorVersion, isLatestVersion, isMajorVersion, isPrivateWorkingCopy, isVersionSeriesCheckedOut

Method Detail

getDocumentType

DocumentType getDocumentType()

Returns the object type as a document type.

Returns:

the document type

Throws:

ClassCastException - if the object type is not a document type

CMIS:

1.0

isVersionable

boolean isVersionable()

Returns whether the document is versionable or not.

Returns:

true if the document is versionable, false if the document is not versionable or if it's unknown

CMIS:

1.0

isVersionSeriesPrivateWorkingCopy

Boolean isVersionSeriesPrivateWorkingCopy()

Determines whether this document is the PWC in the version series or not. The evaluation is based on the properties cmis:isVersionSeriesCheckedOut, cmis:isPrivateWorkingCopy, and cmis:versionSeriesCheckedOutId and works for all CMIS versions.

Returns:

true if it is the PWC, false if it is not the PWC, or null if it can't be determined

See Also:

DocumentProperties.isPrivateWorkingCopy()

CMIS:

1.0

deleteAllVersions

void deleteAllVersions()

Deletes this document and all its versions.

CMIS:

1.0

getContentStream

ContentStream getContentStream()

Retrieves the content stream of this document.

Returns:

the content stream, or null if the document has no content

CMIS:

1.0

getContentStream

ContentStream getContentStream(BigInteger offset,
                               BigInteger length)

Retrieves the content stream of this document.

Parameters:

offset - the offset of the stream or null to read the stream from the beginning

length - the maximum length of the stream or null to read to the end of the stream

Returns:

the content stream, or null if the document has no content

CMIS:

1.0

getContentStream

ContentStream getContentStream(String streamId)

Retrieves the content stream that is associated with the given stream ID. This is usually a rendition of the document.

Parameters:

streamId - the stream ID

Returns:

the content stream, or null if no content is associated with this stream ID

CMIS:

1.0

getContentStream

ContentStream getContentStream(String streamId,
                               BigInteger offset,
                               BigInteger length)

Retrieves the content stream that is associated with the given stream ID. This is usually a rendition of the document.

Parameters:

streamId - the stream ID

offset - the offset of the stream or null to read the stream from the beginning

length - the maximum length of the stream or null to read to the end of the stream

Returns:

the content stream, or null if no content is associated with this stream ID

CMIS:

1.0

getContentUrl

String getContentUrl()

Returns the content URL of the document if the binding supports content URLs. Depending on the repository and the binding, the server might not return the content but an error message. Authentication data is not attached. That is, a user may have to re-authenticate to get the content.

Returns:

the content URL of the document or null if the binding does not support content URLs

getContentUrl

String getContentUrl(String streamId)

Returns the content URL of the document or a rendition if the binding supports content URLs. Depending on the repository and the binding, the server might not return the content but an error message. Authentication data is not attached. That is, a user may have to re-authenticate to get the content.

Parameters:

streamId - the ID of the rendition or null for the document

Returns:

the content URL of the document or rendition or null if the binding does not support content URLs

setContentStream

Document setContentStream(ContentStream contentStream,
                          boolean overwrite)

Sets a new content stream for the document and refreshes this object afterwards. If the repository created a new version, this new document is returned. Otherwise the current document is returned.

The stream in contentStream is consumed but not closed by this method.

Parameters:

contentStream - the content stream

overwrite - if this parameter is set to false and the document already has content, the repository throws a CmisContentAlreadyExistsException

Returns:

the updated document, or null if the repository did not return an object ID

See Also:

ObjectFactory.createContentStream(String, long, String, java.io.InputStream)

CMIS:

1.0

setContentStream

ObjectId setContentStream(ContentStream contentStream,
                          boolean overwrite,
                          boolean refresh)

Sets a new content stream for the document. If the repository created a new version, the object ID of this new version is returned. Otherwise the object ID of the current document is returned.

The stream in contentStream is consumed but not closed by this method.

Parameters:

contentStream - the content stream

overwrite - if this parameter is set to false and the document already has content, the repository throws a CmisContentAlreadyExistsException

refresh - if this parameter is set to true, this object will be refreshed after the new content has been set

Returns:

the updated object ID, or null if the repository did not return an object ID

See Also:

ObjectFactory.createContentStream(String, long, String, java.io.InputStream)

CMIS:

1.0

appendContentStream

Document appendContentStream(ContentStream contentStream,
                             boolean isLastChunk)

Appends a content stream to the content stream of the document and refreshes this object afterwards. If the repository created a new version, this new document is returned. Otherwise the current document is returned.

The stream in contentStream is consumed but not closed by this method.

Parameters:

contentStream - the content stream

isLastChunk - indicates if this stream is the last chunk of the content

Returns:

the updated document, or null if the repository did not return an object ID

See Also:

ObjectFactory.createContentStream(String, long, String, java.io.InputStream)

CMIS:

1.1

appendContentStream

ObjectId appendContentStream(ContentStream contentStream,
                             boolean isLastChunk,
                             boolean refresh)

Appends a content stream to the content stream of the document. If the repository created a new version, the object ID of this new version is returned. Otherwise the object ID of the current document is returned.

The stream in contentStream is consumed but not closed by this method.

Parameters:

contentStream - the content stream

isLastChunk - indicates if this stream is the last chunk of the content

refresh - if this parameter is set to true, this object will be refreshed after the content stream has been appended

Returns:

the updated object ID, or null if the repository did not return an object ID

CMIS:

1.1

deleteContentStream

Document deleteContentStream()

Removes the current content stream from the document and refreshes this object afterwards. If the repository created a new version, this new document is returned. Otherwise the current document is returned.

Returns:

the updated document, or null if the repository did not return an object ID

CMIS:

1.0

deleteContentStream

ObjectId deleteContentStream(boolean refresh)

Removes the current content stream from the document. If the repository created a new version, the object ID of this new version is returned. Otherwise the object ID of the current document is returned.

Parameters:

refresh - if this parameter is set to true, this object will be refreshed after the content stream has been deleted

Returns:

the updated document, or null if the repository did not return an object ID

CMIS:

1.0

createOverwriteOutputStream

OutputStream createOverwriteOutputStream(String filename,
                                         String mimeType)

Creates an OutputStream stream object that can be used to overwrite the current content of the document.

Parameters:

filename - the file name

mimeType - the MIME type

Returns:

the OutputStream object

CMIS:

1.1

createOverwriteOutputStream

OutputStream createOverwriteOutputStream(String filename,
                                         String mimeType,
                                         int bufferSize)

Creates an OutputStream stream object that can be used to overwrite the current content of the document.

Parameters:

filename - the file name

mimeType - the MIME type

bufferSize - buffer size in bytes

Returns:

the OutputStream object

CMIS:

1.1

createAppendOutputStream

OutputStream createAppendOutputStream()

Creates an OutputStream stream object that can be used to append content the current content of the document.

Returns:

the OutputStream object

CMIS:

1.1

createAppendOutputStream

OutputStream createAppendOutputStream(int bufferSize)

Creates an OutputStream stream object that can be used to append content the current content of the document.

Parameters:

bufferSize - buffer size in bytes

Returns:

the OutputStream object

CMIS:

1.1

checkOut

ObjectId checkOut()

Checks out the document and returns the object ID of the PWC (private working copy).

Returns:

PWC object ID

CMIS:

1.0

cancelCheckOut

void cancelCheckOut()

If this is a PWC (private working copy) the check out will be reversed. If this is not a PWC it an exception will be thrown.

CMIS:

1.0

checkIn

ObjectId checkIn(boolean major,
                 Map<String,?> properties,
                 ContentStream contentStream,
                 String checkinComment,
                 List<Policy> policies,
                 List<Ace> addAces,
                 List<Ace> removeAces)

If this is a PWC (private working copy) it performs a check in. If this is not a PWC it an exception will be thrown. The stream in contentStream is consumed but not closed by this method.

Returns:

new document ID

CMIS:

1.0

checkIn

ObjectId checkIn(boolean major,
                 Map<String,?> properties,
                 ContentStream contentStream,
                 String checkinComment)

If this is a PWC (private working copy) it performs a check in. If this is not a PWC it an exception will be thrown. The stream in contentStream is consumed but not closed by this method.

Returns:

new document ID

CMIS:

1.0

getObjectOfLatestVersion

Document getObjectOfLatestVersion(boolean major)

Fetches the latest major or minor version of this document.

Parameters:

major - if true the latest major version will be returned, otherwise the very last version will be returned

Returns:

the latest document object

CMIS:

1.0

getObjectOfLatestVersion

Document getObjectOfLatestVersion(boolean major,
                                  OperationContext context)

Fetches the latest major or minor version of this document using the given OperationContext.

Parameters:

major - if true the latest major version will be returned, otherwise the very last version will be returned

Returns:

the latest document object

CMIS:

1.0

getAllVersions

List<Document> getAllVersions()

Fetches all versions of this document.

The behavior of this method is undefined if the document is not versionable and can be different for each repository.

Returns:

all versions of the version series, sorted by cmis:creationDate descending and preceded by the PWC, if one exists, not null

CMIS:

1.0

getAllVersions

List<Document> getAllVersions(OperationContext context)

Fetches all versions of this document using the given OperationContext.

The behavior of this method is undefined if the document is not versionable and can be different for each repository.

Returns:

all versions of the version series, sorted by cmis:creationDate descending and preceded by the PWC, if one exists, not null

CMIS:

1.0

copy

Document copy(ObjectId targetFolderId)

Creates a copy of this document, including content.

Parameters:

targetFolderId - the ID of the target folder, null to create an unfiled document

Returns:

the new document object

CMIS:

1.0

copy

Document copy(ObjectId targetFolderId,
              Map<String,?> properties,
              VersioningState versioningState,
              List<Policy> policies,
              List<Ace> addACEs,
              List<Ace> removeACEs,
              OperationContext context)

Creates a copy of this document, including content.

Parameters:

targetFolderId - the ID of the target folder, null to create an unfiled document

Returns:

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

CMIS:

1.0