com.stellent.cis.client.api.scs.document.update
Interface ISCSDocumentUpdateAPI

All Superinterfaces:

ICommandAPI

public interface ISCSDocumentUpdateAPI
extends ICommandAPI

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

 ISCSDocumentUpdateAPI commandAPI =
       (ISCSDocumentUpdateAPI)m_commandFacade.getCommandAPI ("document.update", m_commandFacade.getCommandTypeForName ("active"));
 

Field Summary

static java.lang.String

API_CATEGORY Category for this Command API

Method Summary

ICISAPIObjectFactory	getObjectFactory() Retrieve the object factory associated with this API
ISCSDocumentActionResponse	updateInfo(ISCSContext SCSContext, ISCSContent content) Update the document metadata.
ISCSDocumentActionResponse	updateInfo(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSContent content) Update the document metadata.

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

updateInfo

ISCSDocumentActionResponse updateInfo(ISCSContext SCSContext,
                                      ISCSContent content)
                                      throws CommandException

Update the document metadata.

Parameters:

SCSContext - the context object representing the current user

content - info object containing the updated property values

Throws:

CommandException

See Also:

"Content Server Documentation for: UPDATE_DOCINFO"

updateInfo

ISCSDocumentActionResponse updateInfo(ISCSRequestModifier requestModifier,
                                      ISCSContext SCSContext,
                                      ISCSContent content)
                                      throws CommandException

Update the document metadata.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

content - info object containing the updated property values

Throws:

CommandException

See Also:

"Content Server Documentation for: UPDATE_DOCINFO"