ISCSFileAPI

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.stellent.cis.client.api.scs.file
Interface ISCSFileAPI

All Superinterfaces:: ICommandAPI

public interface ISCSFileAPI
extends ICommandAPI
extends ICommandAPI

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

 ISCSFileAPI commandAPI =
       (ISCSFileAPI)m_commandFacade.getCommandAPI ("file", m_commandFacade.getCommandTypeForName ("active"));

Field Summary
`static java.lang.String`	`API_CATEGORY` Category for this Command API

Method Summary
`ISCSConvertedDisplayInfo`	`_createConvertedDisplayInfo()` Create a new converted display info object
`ISCSConvertedFileInfo`	`_createConvertedFileInfo()` Create a new converted file info object
`ISCSFileInfo`	`_createFileInfo()` Create a new file info object.
`ISCSFileRetrievalInfo`	`_createFileRetrievalInfo()` Create a file retrieval object.
`ISCSDynamicConversionResponse`	`executeDynamicConversion(ISCSContext SCSContext, ISCSContentID contentID)` Get a dynamic conversion of a specific rendition of a file.
`ISCSDynamicConversionResponse`	`executeDynamicConversion(ISCSContext SCSContext, ISCSContentID contentID, ISCSConvertedFileInfo convertedFileInfo, ISCSConvertedDisplayInfo convertedDisplayInfo)` Get a dynamic conversion of a specific rendition of a file.
`ISCSDynamicConversionResponse`	`executeDynamicConversion(ISCSContext SCSContext, ISCSDocumentID documentID)` Get a dynamic conversion of a specific rendition of a file.
`ISCSDynamicConversionResponse`	`executeDynamicConversion(ISCSContext SCSContext, ISCSDocumentID documentID, ISCSConvertedFileInfo convertedFileInfo, ISCSConvertedDisplayInfo convertedDisplayInfo)` Get a dynamic conversion of a specific rendition of a file.
`ISCSDynamicConversionResponse`	`executeDynamicConversion(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSContentID contentID)` Get a dynamic conversion of a specific rendition of a file.
`ISCSDynamicConversionResponse`	`executeDynamicConversion(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSContentID contentID, ISCSConvertedFileInfo convertedFileInfo, ISCSConvertedDisplayInfo convertedDisplayInfo)` Get a dynamic conversion of a specific rendition of a file.
`ISCSDynamicConversionResponse`	`executeDynamicConversion(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSDocumentID documentID)` Get a dynamic conversion of a specific rendition of a file.
`ISCSDynamicConversionResponse`	`executeDynamicConversion(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSDocumentID documentID, ISCSConvertedFileInfo convertedFileInfo, ISCSConvertedDisplayInfo convertedDisplayInfo)` Get a dynamic conversion of a specific rendition of a file.
`ICISTransferStream`	`getDynamicConversion(ISCSContext SCSContext, ISCSContentID contentID)` Get a dynamic conversion of a specific rendition of a file.
`ICISTransferStream`	`getDynamicConversion(ISCSContext SCSContext, ISCSContentID contentID, ISCSConvertedFileInfo convertedFileInfo)` Get a dynamic conversion of a specific rendition of a file.
`ICISTransferStream`	`getDynamicConversion(ISCSContext SCSContext, ISCSContentID contentID, ISCSConvertedFileInfo convertedFileInfo, ISCSConvertedDisplayInfo convertedDisplayInfo)` Get a dynamic conversion of a specific rendition of a file.
`ICISTransferStream`	`getDynamicConversion(ISCSContext SCSContext, ISCSDocumentID documentID)` Get a dynamic conversion of a specific rendition of a file.
`ICISTransferStream`	`getDynamicConversion(ISCSContext SCSContext, ISCSDocumentID documentID, ISCSConvertedFileInfo convertedFileInfo)` Get a dynamic conversion of a specific rendition of a file.
`ICISTransferStream`	`getDynamicConversion(ISCSContext SCSContext, ISCSDocumentID documentID, ISCSConvertedFileInfo convertedFileInfo, ISCSConvertedDisplayInfo convertedDisplayInfo)` Get a dynamic conversion of a specific rendition of a file.
`ICISTransferStream`	`getDynamicConversion(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSContentID contentID)` Get a dynamic conversion of a specific rendition of a file.
`ICISTransferStream`	`getDynamicConversion(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSContentID contentID, ISCSConvertedFileInfo convertedFileInfo)` Get a dynamic conversion of a specific rendition of a file.
`ICISTransferStream`	`getDynamicConversion(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSContentID contentID, ISCSConvertedFileInfo convertedFileInfo, ISCSConvertedDisplayInfo convertedDisplayInfo)` Get a dynamic conversion of a specific rendition of a file.
`ICISTransferStream`	`getDynamicConversion(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSDocumentID documentID)` Get a dynamic conversion of a specific rendition of a file.
`ICISTransferStream`	`getDynamicConversion(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSDocumentID documentID, ISCSConvertedFileInfo convertedFileInfo)` Get a dynamic conversion of a specific rendition of a file.
`ICISTransferStream`	`getDynamicConversion(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSDocumentID documentID, ISCSConvertedFileInfo convertedFileInfo, ISCSConvertedDisplayInfo convertedDisplayInfo)` Get a dynamic conversion of a specific rendition of a file.
`ISCSDynamicConverterConfigResponse`	`getDynamicConverterConfig(ISCSContext SCSContext)` Retrieves the document configuration information (security groups, available doc types, etc.)
`ISCSDynamicConverterConfigResponse`	`getDynamicConverterConfig(ISCSRequestModifier requestModifier, ISCSContext SCSContext)` Retrieves the document configuration information (security groups, available doc types, etc.)
`ICISTransferStream`	`getDynamicFile(ISCSContext SCSContext, java.lang.String file)` Retrieve a dynamic file, such as of type hcst, hcsp and hcsf from the content server.
`ICISTransferStream`	`getDynamicFile(ISCSContext SCSContext, java.lang.String file, ISCSConvertedDisplayInfo convertedDisplayInfo)` Retrieve a dynamic file, such as of type hcst, hcsp and hcsf from the content server.
`ICISTransferStream`	`getDynamicFile(ISCSContext SCSContext, java.lang.String file, ISCSFileRetrievalInfo retrievalInfo)` Retrieve a dynamic file, such as of type hcst, hcsp and hcsf from the content server.
`ICISTransferStream`	`getDynamicFile(ISCSContext SCSContext, java.lang.String file, ISCSFileRetrievalInfo retrievalInfo, ISCSConvertedDisplayInfo convertedDisplayInfo)` Retrieve a dynamic file, such as of type hcst, hcsp and hcsf from the content server.
`ICISTransferStream`	`getDynamicFile(ISCSRequestModifier requestModifier, ISCSContext SCSContext, java.lang.String file)` Retrieve a dynamic file, such as of type hcst, hcsp and hcsf from the content server.
`ICISTransferStream`	`getDynamicFile(ISCSRequestModifier requestModifier, ISCSContext SCSContext, java.lang.String file, ISCSConvertedDisplayInfo convertedDisplayInfo)` Retrieve a dynamic file, such as of type hcst, hcsp and hcsf from the content server.
`ICISTransferStream`	`getDynamicFile(ISCSRequestModifier requestModifier, ISCSContext SCSContext, java.lang.String file, ISCSFileRetrievalInfo retrievalInfo)` Retrieve a dynamic file, such as of type hcst, hcsp and hcsf from the content server.
`ICISTransferStream`	`getDynamicFile(ISCSRequestModifier requestModifier, ISCSContext SCSContext, java.lang.String file, ISCSFileRetrievalInfo retrievalInfo, ISCSConvertedDisplayInfo convertedDisplayInfo)` Retrieve a dynamic file, such as of type hcst, hcsp and hcsf from the content server.
`ICISTransferStream`	`getFile(ISCSContext SCSContext, ISCSContentID contentID)` Use the GET_FILE command to retrieve a stream of content from the content server. Will tranfer the files via the `ICISTransferStream` InputStream class.
`ICISTransferStream`	`getFile(ISCSContext SCSContext, ISCSContentID contentID, ISCSFileInfo fileInfo)` Use the GET_FILE command to retrieve a stream of content from the content server. Will tranfer the files via the `ICISTransferStream` InputStream class.
`ICISTransferStream`	`getFile(ISCSContext SCSContext, ISCSDocumentID documentID)` Use the GET_FILE command to retrieve a stream of content from the content server. Will tranfer the files via the `ICISTransferStream` InputStream class.
`ICISTransferStream`	`getFile(ISCSContext SCSContext, ISCSDocumentID documentID, ISCSFileInfo fileInfo)` Use the GET_FILE command to retrieve a stream of content from the content server. Will tranfer the files via the `ICISTransferStream` InputStream class.
`ICISTransferStream`	`getFile(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSContentID contentID)` Use the GET_FILE command to retrieve a stream of content from the content server. Will tranfer the files via the `ICISTransferStream` InputStream class.
`ICISTransferStream`	`getFile(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSContentID contentID, ISCSFileInfo fileInfo)` Use the GET_FILE command to retrieve a stream of content from the content server. Will tranfer the files via the `ICISTransferStream` InputStream class.
`ICISTransferStream`	`getFile(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSDocumentID documentID)` Use the GET_FILE command to retrieve a stream of content from the content server. Will tranfer the files via the `ICISTransferStream` InputStream class.
`ICISTransferStream`	`getFile(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSDocumentID documentID, ISCSFileInfo fileInfo)` Use the GET_FILE command to retrieve a stream of content from the content server. Will tranfer the files via the `ICISTransferStream` InputStream class.
`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