|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ISCSDocumentInformationAPI
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 |
---|
static final java.lang.String API_CATEGORY
Method Detail |
---|
ICISAPIObjectFactory getObjectFactory()
ISCSDocumentConfigurationResponse getDocConfiguration(ISCSContext SCSContext) throws CommandException
SCSContext
- the context object representing the current user
CommandException
ISCSDocumentConfigurationResponse getDocConfiguration(ISCSRequestModifier requestModifier, ISCSContext SCSContext) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current user
CommandException
ISCSCheckinInfoResponse getUpdateInfo(ISCSContext SCSContext, ISCSDocumentID documentID) throws CommandException
SCSContext
- the context object representing the current userdocumentID
- the document ID
CommandException
ISCSCheckinInfoResponse getUpdateInfo(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSDocumentID documentID) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current userdocumentID
- the document ID
CommandException
ISCSDocumentInformationResponse getDocumentInformationByName(ISCSContext SCSContext, ISCSContentID contentID) throws CommandException
SCSContext
- the context object representing the current usercontentID
- the active content ID
CommandException
ISCSDocumentInformationResponse getDocumentInformationByName(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSContentID contentID) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current usercontentID
- the active content ID
CommandException
ISCSDocumentInformationResponse getDocumentInformationByName(ISCSContext SCSContext, ISCSContentID contentID, java.lang.String revisionSelectionMethod) throws CommandException
SCSContext
- the context object representing the current usercontentID
- the active content IDrevisionSelectionMethod
- the revision selection method for determining which document to query (i.e. Latest, LatestReleased, etc.)
CommandException
ISCSDocumentInformationResponse getDocumentInformationByName(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSContentID contentID, java.lang.String revisionSelectionMethod) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current usercontentID
- the active content IDrevisionSelectionMethod
- the revision selection method for determining which document to query (i.e. Latest, LatestReleased, etc.)
CommandException
ISCSDocumentInformationResponse getDocumentInformationByID(ISCSContext SCSContext, ISCSDocumentID documentID) throws CommandException
SCSContext
- the context object representing the current userdocumentID
- the active document ID
CommandException
ISCSDocumentInformationResponse getDocumentInformationByID(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSDocumentID documentID) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current userdocumentID
- the active document ID
CommandException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |