Skip navigation links

com.stellent.cis.client.api.scs.component.cis
Interface ISCSComponentCISAPI

All Superinterfaces:

ICommandAPI

public interface ISCSComponentCISAPI

extends ICommandAPI

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

 ISCSComponentCISAPI commandAPI =
       (ISCSComponentCISAPI)m_commandFacade.getCommandAPI ("component.cis", m_commandFacade.getCommandTypeForName ("active"));
 

Field Summary

static java.lang.String

API_CATEGORY Category for this Command API

Method Summary

ISCSCISDocInfoResponse	getDocumentInformation(ISCSContext SCSContext, ISCSDocumentID documentID) Retrieve the document information.
ISCSCISDocInfoResponse	getDocumentInformation(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSDocumentID documentID) Retrieve the document information.
ICISAPIObjectFactory	getObjectFactory() Retrieve the object factory associated with this API

Field Detail

API_CATEGORY

static final java.lang.String API_CATEGORY

Category for this Command API

See Also:

Constant Field Values

Method Detail

getObjectFactory

ICISAPIObjectFactory getObjectFactory()

Retrieve the object factory associated with this API

getDocumentInformation

ISCSCISDocInfoResponse getDocumentInformation(ISCSContext SCSContext,
                                              ISCSDocumentID documentID)
                                              throws CommandException

Retrieve the document information. Uses the CIS_Helper component to retrieve only a subset of all the DOC_INFO results. Used primarialy for gathering data for file transfers.

Parameters:

SCSContext - the context object representing the current user

documentID - the document ID

Throws:

CommandException

See Also:

"Content Server Documentation for: "CIS_DOC_INFO"

getDocumentInformation

ISCSCISDocInfoResponse getDocumentInformation(ISCSRequestModifier requestModifier,
                                              ISCSContext SCSContext,
                                              ISCSDocumentID documentID)
                                              throws CommandException

Retrieve the document information. Uses the CIS_Helper component to retrieve only a subset of all the DOC_INFO results. Used primarialy for gathering data for file transfers.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

documentID - the document ID

Throws:

CommandException

See Also:

"Content Server Documentation for: "CIS_DOC_INFO"

Skip navigation links