org.apache.chemistry.opencmis.client.api

Interface Rendition

All Superinterfaces:

ExtensionsData, RenditionData

public interface Rendition
extends RenditionData

Rendition.

CMIS:

1.0

Method Summary

Methods

Modifier and Type	Method and Description
ContentStream	getContentStream() Returns the content stream of the rendition.
String	getContentUrl() Returns the content URL of the rendition if the binding supports content URLs.
long	getHeight() Returns the height in pixels if the rendition is an image.
long	getLength() Returns the size of the rendition in bytes if available.
Document	getRenditionDocument() Returns the rendition document if the rendition is a stand-alone document.
Document	getRenditionDocument(OperationContext context) Returns the rendition document using the provides OperationContext if the rendition is a stand-alone document.
long	getWidth() Returns the width in pixels if the rendition is an image.

Methods inherited from interface org.apache.chemistry.opencmis.commons.data.RenditionData

getBigHeight, getBigLength, getBigWidth, getKind, getMimeType, getRenditionDocumentId, getStreamId, getTitle

Methods inherited from interface org.apache.chemistry.opencmis.commons.data.ExtensionsData

getExtensions, setExtensions

Method Detail

getLength

long getLength()

Returns the size of the rendition in bytes if available.

Returns:

the size of the rendition in bytes or -1 if the size is not available

getHeight

long getHeight()

Returns the height in pixels if the rendition is an image.

Returns:

the height in pixels or -1 if the height is not available or the rendition is not an image

getWidth

long getWidth()

Returns the width in pixels if the rendition is an image.

Returns:

the width in pixels or -1 if the width is not available or the rendition is not an image

getRenditionDocument

Document getRenditionDocument()

Returns the rendition document if the rendition is a stand-alone document.

Returns:

the rendition document or null if there is no rendition document

getRenditionDocument

Document getRenditionDocument(OperationContext context)

Returns the rendition document using the provides OperationContext if the rendition is a stand-alone document.

Returns:

the rendition document or null if there is no rendition document

getContentStream

ContentStream getContentStream()

Returns the content stream of the rendition.

Returns:

the content stream of the rendition or null if the rendition has no content

getContentUrl

String getContentUrl()

Returns the content URL of the 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.

Returns:

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