Skip navigation links

oracle.imaging
Interface DocumentContentService

public interface DocumentContentService

Method Summary

javax.activation.DataHandler	retrieve(java.lang.String documentId) Retrieves the original document referenced by the documentId provided.
RenderResult	retrievePage(java.lang.String documentId, RenderOptions options) Retrieves the specified page of a document according to the specifed rendering options.
Rendition	retrieveRendition(java.lang.String documentId, boolean withAnnotations, boolean preserveColor, RenderOptions.RenditionOutput outputType, int[] pages) Retrieves a rendition of the document referenced by the documentId provided and described by the options parameter.
javax.activation.DataHandler	retrieveVersion(java.lang.String documentId, long versionId) Retrieves the original document version referenced by documentId and version number.
RenderResult	retrieveVersionPage(java.lang.String documentId, long versionId, RenderOptions options) Retrieves the specified page of a document according to the specifed rendering options.
Rendition	retrieveVersionRendition(java.lang.String documentId, long versionId, boolean withAnnotations, boolean preserveColor, RenderOptions.RenditionOutput outputType, int[] pages) Retrieves the original document version referenced by documentId and version number.
java.lang.String	uploadDocument(javax.activation.DataHandler data, java.lang.String fileName) Uploads document content to imaging.

Method Detail

uploadDocument

java.lang.String uploadDocument(javax.activation.DataHandler data,
                                java.lang.String fileName)
                                throws ImagingException

Uploads document content to imaging. This operation returns an upload token identifier for subsequent use in the DocumentService createDocument and updateDocument operations. The returned upload token is only valid for the calling user.

Parameters:

data - The document content.

fileName - The file name to use for the document.

Returns:

The upload token.

Throws:

ImagingException

retrieve

javax.activation.DataHandler retrieve(java.lang.String documentId)
                                      throws ImagingException

Retrieves the original document referenced by the documentId provided.

Parameters:

documentId - The document guid of the document to be retrieved

Returns:

a @see{DataHandler} containing the retrieved file

Throws:

ImagingException - is thrown if the requesting user does not have sufficient privileges to view the document without annotations.

retrieveVersion

javax.activation.DataHandler retrieveVersion(java.lang.String documentId,
                                             long versionId)
                                             throws ImagingException

Retrieves the original document version referenced by documentId and version number.

Parameters:

documentId - The document guid of the document to be retrieved

versionId - The version guid of the document to be retrieved

Returns:

a @see{DataHandler} containing the retrieved file

Throws:

ImagingException - is thrown if the requesting user does not have sufficient privileges to view the document without annotations.

retrieveRendition

Rendition retrieveRendition(java.lang.String documentId,
                            boolean withAnnotations,
                            boolean preserveColor,
                            RenderOptions.RenditionOutput outputType,
                            int[] pages)
                            throws ImagingException

Retrieves a rendition of the document referenced by the documentId provided and described by the options parameter.

Parameters:

documentId - The document guid of the document to be retrieved

withAnnotations - indicates that the retrieve should be attempted with or without annotations

outputType - Options describing the rendered output

pages - indicates the specific pages that should be retrieved from the source document. If a @see{null} value or zero element array is specified, all pages of the document are retrieved.

Returns:

an @see{Rendition} containing the retrieved object and related information

Throws:

ImagingException - is thrown if the requesting user does not have sufficient privileges to view the document without annotations.

retrieveVersionRendition

Rendition retrieveVersionRendition(java.lang.String documentId,
                                   long versionId,
                                   boolean withAnnotations,
                                   boolean preserveColor,
                                   RenderOptions.RenditionOutput outputType,
                                   int[] pages)
                                   throws ImagingException

Retrieves the original document version referenced by documentId and version number.

Parameters:

documentId - The document guid of the document to be retrieved

versionId - The version guid of the document to be retrieved

withAnnotations - indicates that the retrieve should be attempted with or without annotations

outputType - Options describing the rendered output

pages - indicates the specific pages that should be retrieved from the source document. If a @see{null} value or a zero element array is specified, all pages of the document are retrieved.

Returns:

an @see{Rendition} containing the retrieved file and related information

Throws:

ImagingException - is thrown if the requesting user does not have sufficient privileges to view the document without annotations.

retrievePage

RenderResult retrievePage(java.lang.String documentId,
                          RenderOptions options)
                          throws ImagingException

Retrieves the specified page of a document according to the specifed rendering options.

Parameters:

documentId - The document guid of the document to be rendered

options - A data structure specfity the options to be used for rendering the document

Throws:

ImagingException

retrieveVersionPage

RenderResult retrieveVersionPage(java.lang.String documentId,
                                 long versionId,
                                 RenderOptions options)
                                 throws ImagingException

Retrieves the specified page of a document according to the specifed rendering options.

Parameters:

documentId - The document guid of the document to be rendered

versionId - The version guid of the document to be retrieved

options - A data structure specfity the options to be used for rendering the document

Throws:

ImagingException

Skip navigation links