com.adobe.icc.services.api

Interface DownloadService

public interface DownloadService

Service interface for Downloading main or test/sample content for various Asset types (Text, Form, Image, etc.).

Method Summary

Modifier and Type	Method and Description
Downloadable	getObjectData(Integer objType, String recordID) Get the content or data bytes for an Asset type given its ID.
Downloadable	getObjectData(Integer objType, String objName, Integer objVersion, Integer objState) Get the content or data bytes for an Asset type given its name, state and version.
Downloadable	getObjectTestData(Integer objType, String recordID) Get the test/sample content or data associated with a Asset type given its ID.

Method Detail

getObjectData

Downloadable getObjectData(Integer objType,
                           String objName,
                           Integer objVersion,
                           Integer objState)
                    throws ICCException

Get the content or data bytes for an Asset type given its name, state and version.

Valid only for Text, Image, Form and Letter's Expression_SWF Asset types.

For a Form, the XDP content is returned.
For a TextModule, the XML content of the Text is returned.
For a ImageModule, the image bytes are returned.
For a ContentDataModule, the content bytes are returned.
For a Letter, the Letter's generated Expression SWF is returned.

Parameters:

objType - Type of the Asset whose content is to be retrieved. See com.adobe.icc.dbforms.util.DBConstants for list of Asset types.
For Letter_Expression_SWF Asset type, the Letter is referred to as the object, i.e., objName is the Letter's name, objVersion is the Letter's version and objState State is the Letter's state.

objName - Name of the Asset.

objVersion - Version of the Asset.

objState - State of the Asset.

Returns:

Downloadable object which would contain the relevant content for the Asset.

Throws:

ICCException

getObjectData

Downloadable getObjectData(Integer objType,
                           String recordID)
                    throws ICCException

Get the content or data bytes for an Asset type given its ID.

Valid only for Text, Image, Form and Letter's Expression_SWF Asset types.

For a Form, the XDP content is returned.
For a TextModule, the XML content of the Text is returned.
For a ImageModule, the image bytes are returned.
For a ContentDataModule, the content bytes are returned.
For a Letter, the Letter's generated Expression SWF is returned.

Parameters:

objType - Type of the Asset whose content is to be retrieved. See com.adobe.icc.dbforms.util.DBConstants for list of Asset types.
For Letter_Expression_SWF Asset type, the Letter is referred to as the object, i.e., objName is the Letter's name, objVersion is the Letter's version and objState State is the Letter's state.

recordID - ID of the Asset whose content is to be retrieved.

Returns:

Downloadable object which would contain the relevant content for the Asset.

Throws:

ICCException

getObjectTestData

Downloadable getObjectTestData(Integer objType,
                               String recordID)
                        throws ICCException

Get the test/sample content or data associated with a Asset type given its ID.

Test data is valid only for Letter Asset types.

Parameters:

objType - type of the object. See com.adobe.icc.dbforms.util.DBConstants for list of Asset types.

recordID - ID of the Asset whose test data is to be retrieved.

Returns:

Downloadable object which would contain the relevant test/sample data for the Asset.

Throws:

ICCException