|
Oracle® Fusion Middleware Content Integration Suite (CIS) Java API Reference 11g Release 1 (11.1) E17350-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ISCSDocumentCheckoutAPI
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 |
---|
static final java.lang.String API_CATEGORY
Method Detail |
---|
ICISAPIObjectFactory getObjectFactory()
ISCSCheckedOutListResponse listCheckedOutItems(ISCSContext SCSContext) throws CommandException
SCSContext
- the context object representing the current userCommandException
ISCSCheckedOutListResponse listCheckedOutItems(ISCSRequestModifier requestModifier, ISCSContext SCSContext) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current userCommandException
ISCSDocumentActionResponse checkoutFileByID(ISCSContext SCSContext, ISCSDocumentID documentID) throws CommandException
SCSContext
- the context object representing the current userdocumentID
- the document IDCommandException
ISCSDocumentActionResponse checkoutFileByID(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSDocumentID documentID) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current userdocumentID
- the document IDCommandException
ISCSDocumentActionResponse checkoutFileByName(ISCSContext SCSContext, ISCSContentID contentID) throws CommandException
SCSContext
- the context object representing the current usercontentID
- the content IDCommandException
ISCSDocumentActionResponse checkoutFileByName(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSContentID contentID) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current usercontentID
- the content IDCommandException
ISCSDocumentActionResponse undoCheckoutFileByID(ISCSContext SCSContext, ISCSDocumentID documentID) throws CommandException
SCSContext
- the context object representing the current userdocumentID
- the document IDCommandException
ISCSDocumentActionResponse undoCheckoutFileByID(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSDocumentID documentID) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current userdocumentID
- the document IDCommandException
ISCSDocumentActionResponse undoCheckoutFileByName(ISCSContext SCSContext, ISCSContentID contentID) throws CommandException
SCSContext
- the context object representing the current usercontentID
- the content IDCommandException
ISCSDocumentActionResponse undoCheckoutFileByName(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSContentID contentID) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current usercontentID
- the content IDCommandException
|
Oracle® Fusion Middleware Content Integration Suite (CIS) Java API Reference 11g Release 1 (11.1) E17350-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |