com.stellent.cis.client.api.sis.document
Interface ISISDocumentAPI

All Superinterfaces:

ICommandAPI

public interface ISISDocumentAPI
extends ICommandAPI

The command API implementation of the document commands. This implementation can be accessed directly via the ICommandFacade class, using the API name document, with the following syntax:

 ISISDocumentAPI commandAPI =
       (ISISDocumentAPI)m_commandFacade.getCommandAPI ("document", m_commandFacade.getCommandTypeForName ("fixed"));
 

Field Summary

static java.lang.String

API_CATEGORY Category for this Command API

Method Summary

ISISID	_createID()
ISISCreateDocumentResponse	createDocument(ISISContext SISContext, ISISCreateDocumentRequest createDocumentRequest) Creates a document in the Stellent Image Server system.
java.util.List	getContentPages(ISISContext SISContext, ISISID identifier) Returns a list of available content pages for the specified identifier.
java.util.List	getContentPages(ISISContext SISContext, ISISID identifier, int dpi, int type, java.lang.String namespace, int scale, boolean highestResolution) Returns a list of available content pages for the specified identifier.
ISISApplicationResponse	getCreatableApplications(ISISContext SISContext) Retrieves a list of application types that can be used to create new documents.
ISISCreateDocumentRequest	getCreateDocumentRequest(ISISContext SISContext, ISISApplication application) This allows the client to obtain a list of fields for the application specified.
ICISTransferStream	getPageStream(ISISContext SISContext, ISISContentPage page) Retrieves the stream for the page indicated.
java.util.List	purgeCache(ISISContext SISContext, java.lang.String namespace) Removes previously exported documents from the server cache.
java.lang.String	uploadStream(ISISContext SISContext, ICISTransferStream stream) Uploads the specified stream to the Stellent Image Server, returns a ticket for use in further contribution related calls.

Field Detail

API_CATEGORY

static final java.lang.String API_CATEGORY

Category for this Command API

See Also:

Constant Field Values

Method Detail

getContentPages

java.util.List getContentPages(ISISContext SISContext,
                               ISISID identifier)
                               throws CommandException

Returns a list of available content pages for the specified identifier. ISISContentPage

Parameters:

SISContext - the context object representing the current user

identifier - The identifier for the piece of content to get pages from.

Throws:

CommandException

getContentPages

java.util.List getContentPages(ISISContext SISContext,
                               ISISID identifier,
                               int dpi,
                               int type,
                               java.lang.String namespace,
                               int scale,
                               boolean highestResolution)
                               throws CommandException

Returns a list of available content pages for the specified identifier. ISISContentPage

Parameters:

SISContext - the context object representing the current user

identifier - The identifier for the piece of content to get pages from.

dpi - An integer stating the DPI setting of the exported document. Default is 96.

type - An integer that represents the format of the exported document. (3 = Image, 5 = Optika, 9 = Native, 8 = PDF) Default is 3.

namespace - The name of the session sub folder in which the documents will be exported. Default is "AcordeContextExport".

scale - An integer stating the zoom percent of the exported document. Default is 140.

highestResolution - Default is false.

Throws:

CommandException

createDocument

ISISCreateDocumentResponse createDocument(ISISContext SISContext,
                                          ISISCreateDocumentRequest createDocumentRequest)
                                          throws CommandException

Creates a document in the Stellent Image Server system.

Parameters:

SISContext - the context object representing the current user

createDocumentRequest - The application type to get request for.

Throws:

CommandException

getCreatableApplications

ISISApplicationResponse getCreatableApplications(ISISContext SISContext)
                                                 throws CommandException

Retrieves a list of application types that can be used to create new documents.

Parameters:

SISContext - the context object representing the current user

Throws:

CommandException

getCreateDocumentRequest

ISISCreateDocumentRequest getCreateDocumentRequest(ISISContext SISContext,
                                                   ISISApplication application)
                                                   throws CommandException

This allows the client to obtain a list of fields for the application specified. The fields will be returned in a format that is ready for a Create Document request.

Parameters:

SISContext - the context object representing the current user

application - The application type to get request for.

Throws:

CommandException

getPageStream

ICISTransferStream getPageStream(ISISContext SISContext,
                                 ISISContentPage page)
                                 throws CommandException

Retrieves the stream for the page indicated. Returns an inputstream for the requested page.

Parameters:

SISContext - the context object representing the current user

page - The page to get the stream for.

Throws:

CommandException

purgeCache

java.util.List purgeCache(ISISContext SISContext,
                          java.lang.String namespace)
                          throws CommandException

Removes previously exported documents from the server cache. Returns a list of page objects ISISContentPage that were purged.

Parameters:

SISContext - the context object representing the current user

namespace - The name of the session sub folder in which the documents will be purged.

Throws:

CommandException

uploadStream

java.lang.String uploadStream(ISISContext SISContext,
                              ICISTransferStream stream)
                              throws CommandException

Uploads the specified stream to the Stellent Image Server, returns a ticket for use in further contribution related calls.

Parameters:

SISContext - the context object representing the current user

stream - The stream to upload.

Throws:

CommandException

_createID

ISISID _createID()