|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ISISDocumentAPI
The command API implementation of the document commands.
This implementation can be accessed directly via the ICommandFacade
class, using the API
name document, with the following syntax:
ISISDocumentAPI commandAPI = (ISISDocumentAPI)m_commandFacade.getCommandAPI ("document", m_commandFacade.getCommandTypeForName ("fixed"));
Field Summary | |
---|---|
static java.lang.String |
API_CATEGORY
Category for this Command API |
Method Summary | |
---|---|
ISISID |
_createID()
|
ISISCreateDocumentResponse |
createDocument(ISISContext SISContext,
ISISCreateDocumentRequest createDocumentRequest)
Creates a document in the Stellent Image Server system. |
java.util.List |
getContentPages(ISISContext SISContext,
ISISID identifier)
Returns a list of available content pages for the specified identifier. |
java.util.List |
getContentPages(ISISContext SISContext,
ISISID identifier,
int dpi,
int type,
java.lang.String namespace,
int scale,
boolean highestResolution)
Returns a list of available content pages for the specified identifier. |
ISISApplicationResponse |
getCreatableApplications(ISISContext SISContext)
Retrieves a list of application types that can be used to create new documents. |
ISISCreateDocumentRequest |
getCreateDocumentRequest(ISISContext SISContext,
ISISApplication application)
This allows the client to obtain a list of fields for the application specified. |
ICISTransferStream |
getPageStream(ISISContext SISContext,
ISISContentPage page)
Retrieves the stream for the page indicated. |
java.util.List |
purgeCache(ISISContext SISContext,
java.lang.String namespace)
Removes previously exported documents from the server cache. |
java.lang.String |
uploadStream(ISISContext SISContext,
ICISTransferStream stream)
Uploads the specified stream to the Stellent Image Server, returns a ticket for use in further contribution related calls. |
Field Detail |
---|
static final java.lang.String API_CATEGORY
Method Detail |
---|
java.util.List getContentPages(ISISContext SISContext, ISISID identifier) throws CommandException
ISISContentPage
SISContext
- the context object representing the current useridentifier
- The identifier for the piece of content to get pages from.
CommandException
java.util.List getContentPages(ISISContext SISContext, ISISID identifier, int dpi, int type, java.lang.String namespace, int scale, boolean highestResolution) throws CommandException
ISISContentPage
SISContext
- the context object representing the current useridentifier
- The identifier for the piece of content to get pages from.dpi
- An integer stating the DPI setting of the exported document. Default is 96.type
- An integer that represents the format of the exported document. (3 = Image, 5 = Optika, 9 = Native, 8 = PDF) Default is 3.namespace
- The name of the session sub folder in which the documents will be exported. Default is "AcordeContextExport".scale
- An integer stating the zoom percent of the exported document. Default is 140.highestResolution
- Default is false.
CommandException
ISISCreateDocumentResponse createDocument(ISISContext SISContext, ISISCreateDocumentRequest createDocumentRequest) throws CommandException
SISContext
- the context object representing the current usercreateDocumentRequest
- The application type to get request for.
CommandException
ISISApplicationResponse getCreatableApplications(ISISContext SISContext) throws CommandException
SISContext
- the context object representing the current user
CommandException
ISISCreateDocumentRequest getCreateDocumentRequest(ISISContext SISContext, ISISApplication application) throws CommandException
SISContext
- the context object representing the current userapplication
- The application type to get request for.
CommandException
ICISTransferStream getPageStream(ISISContext SISContext, ISISContentPage page) throws CommandException
SISContext
- the context object representing the current userpage
- The page to get the stream for.
CommandException
java.util.List purgeCache(ISISContext SISContext, java.lang.String namespace) throws CommandException
ISISContentPage
that were purged.
SISContext
- the context object representing the current usernamespace
- The name of the session sub folder in which the documents will be purged.
CommandException
java.lang.String uploadStream(ISISContext SISContext, ICISTransferStream stream) throws CommandException
SISContext
- the context object representing the current userstream
- The stream to upload.
CommandException
ISISID _createID()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |