Skip navigation links

com.stellent.cis.client.api.scs.document.information
Interface ISCSDocumentInformationAPI

All Superinterfaces:

ICommandAPI

public interface ISCSDocumentInformationAPI

extends ICommandAPI

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

 ISCSDocumentInformationAPI commandAPI =
       (ISCSDocumentInformationAPI)m_commandFacade.getCommandAPI ("document.information", m_commandFacade.getCommandTypeForName ("active"));
 

Field Summary

static java.lang.String

API_CATEGORY Category for this Command API

Method Summary

ISCSDocumentConfigurationResponse	getDocConfiguration(ISCSContext SCSContext) Retrieves the document configuration information (security groups, available doc types, etc.)
ISCSDocumentConfigurationResponse	getDocConfiguration(ISCSRequestModifier requestModifier, ISCSContext SCSContext) Retrieves the document configuration information (security groups, available doc types, etc.)
ISCSDocumentInformationResponse	getDocumentInformationByID(ISCSContext SCSContext, ISCSDocumentID documentID) Retrieve the metadata information for the document identified by the given name or by revision ID.
ISCSDocumentInformationResponse	getDocumentInformationByID(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSDocumentID documentID) Retrieve the metadata information for the document identified by the given name or by revision ID.
ISCSDocumentInformationResponse	getDocumentInformationByName(ISCSContext SCSContext, ISCSContentID contentID) Retrieve the metadata information for the document identified by the given name or by revision ID.
ISCSDocumentInformationResponse	getDocumentInformationByName(ISCSContext SCSContext, ISCSContentID contentID, java.lang.String revisionSelectionMethod) Retrieve the metadata information for the document identified by the given name or by revision ID.
ISCSDocumentInformationResponse	getDocumentInformationByName(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSContentID contentID) Retrieve the metadata information for the document identified by the given name or by revision ID.
ISCSDocumentInformationResponse	getDocumentInformationByName(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSContentID contentID, java.lang.String revisionSelectionMethod) Retrieve the metadata information for the document identified by the given name or by revision ID.
ICISAPIObjectFactory	getObjectFactory() Retrieve the object factory associated with this API
ISCSCheckinInfoResponse	getUpdateInfo(ISCSContext SCSContext, ISCSDocumentID documentID) Gets information for building a contribution form with similar metaddata to another piece of content.
ISCSCheckinInfoResponse	getUpdateInfo(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSDocumentID documentID) Gets information for building a contribution form with similar metaddata to another piece of content.

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

getDocConfiguration

ISCSDocumentConfigurationResponse getDocConfiguration(ISCSContext SCSContext)
                                                      throws CommandException

Retrieves the document configuration information (security groups, available doc types, etc.)

Parameters:

SCSContext - the context object representing the current user

Throws:

CommandException

See Also:

"Content Server Documentation for: GET_DOC_CONFIG_INFO"

getDocConfiguration

ISCSDocumentConfigurationResponse getDocConfiguration(ISCSRequestModifier requestModifier,
                                                      ISCSContext SCSContext)
                                                      throws CommandException

Retrieves the document configuration information (security groups, available doc types, etc.)

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

Throws:

CommandException

See Also:

"Content Server Documentation for: GET_DOC_CONFIG_INFO"

getUpdateInfo

ISCSCheckinInfoResponse getUpdateInfo(ISCSContext SCSContext,
                                      ISCSDocumentID documentID)
                                      throws CommandException

Gets information for building a contribution form with similar metaddata to another piece of content.

Parameters:

SCSContext - the context object representing the current user

documentID - the document ID

Throws:

CommandException

See Also:

"Content Server Documentation for: GET_UPDATE_FORM"

getUpdateInfo

ISCSCheckinInfoResponse getUpdateInfo(ISCSRequestModifier requestModifier,
                                      ISCSContext SCSContext,
                                      ISCSDocumentID documentID)
                                      throws CommandException

Gets information for building a contribution form with similar metaddata to another piece of content.

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: GET_UPDATE_FORM"

getDocumentInformationByName

ISCSDocumentInformationResponse getDocumentInformationByName(ISCSContext SCSContext,
                                                             ISCSContentID contentID)
                                                             throws CommandException

Retrieve the metadata information for the document identified by the given name or by revision ID.

Parameters:

SCSContext - the context object representing the current user

contentID - the active content ID

Throws:

CommandException

See Also:

"Content Server Documentation for: "DOC_INFO_BY_NAME"

getDocumentInformationByName

ISCSDocumentInformationResponse getDocumentInformationByName(ISCSRequestModifier requestModifier,
                                                             ISCSContext SCSContext,
                                                             ISCSContentID contentID)
                                                             throws CommandException

Retrieve the metadata information for the document identified by the given name or by revision ID.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

contentID - the active content ID

Throws:

CommandException

See Also:

"Content Server Documentation for: "DOC_INFO_BY_NAME"

getDocumentInformationByName

ISCSDocumentInformationResponse getDocumentInformationByName(ISCSContext SCSContext,
                                                             ISCSContentID contentID,
                                                             java.lang.String revisionSelectionMethod)
                                                             throws CommandException

Retrieve the metadata information for the document identified by the given name or by revision ID.

Parameters:

SCSContext - the context object representing the current user

contentID - the active content ID

revisionSelectionMethod - the revision selection method for determining which document to query (i.e. Latest, LatestReleased, etc.)

Throws:

CommandException

See Also:

"Content Server Documentation for: "DOC_INFO_BY_NAME"

getDocumentInformationByName

ISCSDocumentInformationResponse getDocumentInformationByName(ISCSRequestModifier requestModifier,
                                                             ISCSContext SCSContext,
                                                             ISCSContentID contentID,
                                                             java.lang.String revisionSelectionMethod)
                                                             throws CommandException

Retrieve the metadata information for the document identified by the given name or by revision ID.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

contentID - the active content ID

revisionSelectionMethod - the revision selection method for determining which document to query (i.e. Latest, LatestReleased, etc.)

Throws:

CommandException

See Also:

"Content Server Documentation for: "DOC_INFO_BY_NAME"

getDocumentInformationByID

ISCSDocumentInformationResponse getDocumentInformationByID(ISCSContext SCSContext,
                                                           ISCSDocumentID documentID)
                                                           throws CommandException

Retrieve the metadata information for the document identified by the given name or by revision ID.

Parameters:

SCSContext - the context object representing the current user

documentID - the active document ID

Throws:

CommandException

See Also:

"Content Server Documentation for: "DOC_INFO_BY_NAME"

getDocumentInformationByID

ISCSDocumentInformationResponse getDocumentInformationByID(ISCSRequestModifier requestModifier,
                                                           ISCSContext SCSContext,
                                                           ISCSDocumentID documentID)
                                                           throws CommandException

Retrieve the metadata information for the document identified by the given name or by revision ID.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

documentID - the active document ID

Throws:

CommandException

See Also:

"Content Server Documentation for: "DOC_INFO_BY_NAME"

Skip navigation links