com.stellent.cis.client.api.common.document
Interface ICISDocumentAPI

All Superinterfaces:

ICommandAPI

public interface ICISDocumentAPI
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:

 ICISDocumentAPI commandAPI =
       (ICISDocumentAPI)m_commandFacade.getCommandAPI ("document", m_commandFacade.getCommandTypeForName ("common"));
 

Field Summary

static java.lang.String

API_CATEGORY Category for this Command API

Method Summary

ICISCheckinResponse	checkinStream(IContext context, java.lang.String commonType, ICISCommonMetadataMap metadataMap, ICISContent content, ICISTransferStream stream) Checkin a stream to a fixed or active repository.
java.util.List	getContentPages(ICISCommonContext commonContext, ICISID identifier) Returns a list of objects that identify various content streams / conversions associated with the document specified.
ICISTransferStream	getContentStream(ICISCommonContext commonContext, ICISContentPage contentPage) Returns the primary content stream if identifier is specified.
ICISTransferStream	getContentStream(ICISCommonContext commonContext, ICISID identifier) Returns the primary content stream if identifier is specified.

Field Detail

API_CATEGORY

static final java.lang.String API_CATEGORY

Category for this Command API

See Also:

Constant Field Values

Method Detail

checkinStream

ICISCheckinResponse checkinStream(IContext context,
                                  java.lang.String commonType,
                                  ICISCommonMetadataMap metadataMap,
                                  ICISContent content,
                                  ICISTransferStream stream)
                                  throws CommandException

Checkin a stream to a fixed or active repository.

Parameters:

context - The context that describes the adapter to contribute to.

commonType - The type of document that is being contributed.

metadataMap - The mapping between various adapters.

content - The metadata associated with content that is to be contributed.

stream - The content stream to contribute.

Throws:

CommandException

getContentPages

java.util.List getContentPages(ICISCommonContext commonContext,
                               ICISID identifier)
                               throws CommandException

Returns a list of objects that identify various content streams / conversions associated with the document specified. ICISContentPage

Parameters:

commonContext - the common context object, containing the contextual information for each adapter

identifier - the identifier of the document to return pages for.

Throws:

CommandException

getContentStream

ICISTransferStream getContentStream(ICISCommonContext commonContext,
                                    ICISContentPage contentPage)
                                    throws CommandException

Returns the primary content stream if identifier is specified. Or the stream represented by the specified content page.

Parameters:

commonContext - the common context object, containing the contextual information for each adapter

contentPage - The content page to return stream for.

Throws:

CommandException

getContentStream

ICISTransferStream getContentStream(ICISCommonContext commonContext,
                                    ICISID identifier)
                                    throws CommandException

Returns the primary content stream if identifier is specified. Or the stream represented by the specified content page.

Parameters:

commonContext - the common context object, containing the contextual information for each adapter

identifier - The identifier to return stream for.

Throws:

CommandException