com.stellent.cis.client.api.scs.document.checkout
Interface ISCSDocumentCheckoutAPI

All Superinterfaces:

ICommandAPI

public interface ISCSDocumentCheckoutAPI
extends ICommandAPI

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

 ISCSDocumentCheckoutAPI commandAPI =
       (ISCSDocumentCheckoutAPI)m_commandFacade.getCommandAPI ("document.checkout", m_commandFacade.getCommandTypeForName ("active"));
 

Field Summary

static java.lang.String

API_CATEGORY Category for this Command API

Method Summary

ISCSDocumentActionResponse	checkoutFileByID(ISCSContext SCSContext, ISCSDocumentID documentID) Checkout the given document ID from the content server.
ISCSDocumentActionResponse	checkoutFileByID(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSDocumentID documentID) Checkout the given document ID from the content server.
ISCSDocumentActionResponse	checkoutFileByName(ISCSContext SCSContext, ISCSContentID contentID) Checkout the document with the given name from the content server.
ISCSDocumentActionResponse	checkoutFileByName(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSContentID contentID) Checkout the document with the given name from the content server.
ICISAPIObjectFactory	getObjectFactory() Retrieve the object factory associated with this API
ISCSCheckedOutListResponse	listCheckedOutItems(ISCSContext SCSContext) Retrieves a list of all available items that are currently checked out.
ISCSCheckedOutListResponse	listCheckedOutItems(ISCSRequestModifier requestModifier, ISCSContext SCSContext) Retrieves a list of all available items that are currently checked out.
ISCSDocumentActionResponse	undoCheckoutFileByID(ISCSContext SCSContext, ISCSDocumentID documentID) Undo a checkout from the content server
ISCSDocumentActionResponse	undoCheckoutFileByID(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSDocumentID documentID) Undo a checkout from the content server
ISCSDocumentActionResponse	undoCheckoutFileByName(ISCSContext SCSContext, ISCSContentID contentID) Undo a checkout from the content server
ISCSDocumentActionResponse	undoCheckoutFileByName(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSContentID contentID) Undo a checkout from the content server

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

listCheckedOutItems

ISCSCheckedOutListResponse listCheckedOutItems(ISCSContext SCSContext)
                                               throws CommandException

Retrieves a list of all available items that are currently checked out.

Parameters:

SCSContext - the context object representing the current user

Throws:

CommandException

See Also:

"Content Server Documentation for: CHECKIN_LIST"

listCheckedOutItems

ISCSCheckedOutListResponse listCheckedOutItems(ISCSRequestModifier requestModifier,
                                               ISCSContext SCSContext)
                                               throws CommandException

Retrieves a list of all available items that are currently checked out.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

Throws:

CommandException

See Also:

"Content Server Documentation for: CHECKIN_LIST"

checkoutFileByID

ISCSDocumentActionResponse checkoutFileByID(ISCSContext SCSContext,
                                            ISCSDocumentID documentID)
                                            throws CommandException

Checkout the given document ID 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: CHECKOUT"

checkoutFileByID

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

Checkout the given document ID 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: CHECKOUT"

checkoutFileByName

ISCSDocumentActionResponse checkoutFileByName(ISCSContext SCSContext,
                                              ISCSContentID contentID)
                                              throws CommandException

Checkout the document with the given name from the content server.

Parameters:

SCSContext - the context object representing the current user

contentID - the content ID

Throws:

CommandException

See Also:

"Content Server Documentation for: CHECKOUT_BY_NAME"

checkoutFileByName

ISCSDocumentActionResponse checkoutFileByName(ISCSRequestModifier requestModifier,
                                              ISCSContext SCSContext,
                                              ISCSContentID contentID)
                                              throws CommandException

Checkout the document with the given name from the content server.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

contentID - the content ID

Throws:

CommandException

See Also:

"Content Server Documentation for: CHECKOUT_BY_NAME"

undoCheckoutFileByID

ISCSDocumentActionResponse undoCheckoutFileByID(ISCSContext SCSContext,
                                                ISCSDocumentID documentID)
                                                throws CommandException

Undo a checkout 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: UNDO_CHECKOUT"

undoCheckoutFileByID

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

Undo a checkout 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: UNDO_CHECKOUT"

undoCheckoutFileByName

ISCSDocumentActionResponse undoCheckoutFileByName(ISCSContext SCSContext,
                                                  ISCSContentID contentID)
                                                  throws CommandException

Undo a checkout from the content server

Parameters:

SCSContext - the context object representing the current user

contentID - the content ID

Throws:

CommandException

See Also:

"Content Server Documentation for: UNDO_CHECKOUT_BY_NAME"

undoCheckoutFileByName

ISCSDocumentActionResponse undoCheckoutFileByName(ISCSRequestModifier requestModifier,
                                                  ISCSContext SCSContext,
                                                  ISCSContentID contentID)
                                                  throws CommandException

Undo a checkout from the content server

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

contentID - the content ID

Throws:

CommandException

See Also:

"Content Server Documentation for: UNDO_CHECKOUT_BY_NAME"