com.stellent.cis.client.api.scs.document.delete
Interface ISCSDocumentDeleteAPI

All Superinterfaces:

ICommandAPI

public interface ISCSDocumentDeleteAPI
extends ICommandAPI

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

 ISCSDocumentDeleteAPI commandAPI =
       (ISCSDocumentDeleteAPI)m_commandFacade.getCommandAPI ("document.delete", m_commandFacade.getCommandTypeForName ("active"));
 

Field Summary

static java.lang.String

API_CATEGORY Category for this Command API

Method Summary

ISCSServerResponse	deleteContent(ISCSContext SCSContext, ISCSDocumentID documentID) Delete the document from the Content Server.
ISCSServerResponse	deleteContent(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSDocumentID documentID) Delete the document from the Content Server.
ISCSDocumentActionResponse	deleteRevision(ISCSContext SCSContext, ISCSDocumentID documentID) Delete a revision from the content server.
ISCSDocumentActionResponse	deleteRevision(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSDocumentID documentID) Delete a revision from the content server.
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

deleteContent

ISCSServerResponse deleteContent(ISCSContext SCSContext,
                                 ISCSDocumentID documentID)
                                 throws CommandException

Delete the document from the Content Server. This will remove all revisions of the document associated with the given document ID.

Parameters:

SCSContext - the context object representing the current user

documentID - the ID of the content to remove

Throws:

CommandException

See Also:

"Content Server Documentation for: DELETE_DOC"

deleteContent

ISCSServerResponse deleteContent(ISCSRequestModifier requestModifier,
                                 ISCSContext SCSContext,
                                 ISCSDocumentID documentID)
                                 throws CommandException

Delete the document from the Content Server. This will remove all revisions of the document associated with the given document ID.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

documentID - the ID of the content to remove

Throws:

CommandException

See Also:

"Content Server Documentation for: DELETE_DOC"

deleteRevision

ISCSDocumentActionResponse deleteRevision(ISCSContext SCSContext,
                                          ISCSDocumentID documentID)
                                          throws CommandException

Delete a revision from the content server.

Parameters:

SCSContext - the context object representing the current user

documentID - the document ID

Throws:

CommandException

See Also:

"Content Server Documentation for: DELETE_REV_EX"

deleteRevision

ISCSDocumentActionResponse deleteRevision(ISCSRequestModifier requestModifier,
                                          ISCSContext SCSContext,
                                          ISCSDocumentID documentID)
                                          throws CommandException

Delete a revision from the content server.

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