com.adobe.icc.services.api
Interface AssetExportService

public interface AssetExportService

Export/Import using CRX Package

Method Summary

void	deletePackage(java.lang.String packageName) Deletes the specified package
Downloadable	exportAll(java.lang.String packageName) Exports all assets(published/mark-for-published assets) and data dictionary (non-system)
Downloadable	exportAsset(java.util.List assetIDs, java.lang.String packageName) Export assets as CRX package
Downloadable	exportAsset(java.util.List assetIDs, java.lang.String packageName, boolean findRelatedAssets) Export assets as CRX package
java.util.List	getExportAllInfo() Information about all assets being exported
java.util.List	getExportInfo(java.util.List assetIDs) List of all assets which will be exported when asset with assetID is exported/imported
java.util.List	getImportInfo(Downloadable file) Deprecated. use getImportInfo2
java.util.Map	getImportInfo2(Downloadable file) List all the assets, categories and data dictionary to be imported from the file.
java.util.List	importAsset(Downloadable file) Deprecated. use importAsset2
java.util.List	importAsset2(java.util.Map packageInfo) Imports assets.

Method Detail

getExportInfo

java.util.List getExportInfo(java.util.List assetIDs)
                             throws ICCException

List of all assets which will be exported when asset with assetID is exported/imported

Parameters:

assetIDs - list of ID of assets to be exported

Returns:

list of all asset (TextModule, ListDataModule, ConditionalDataModule, ImageModule, Form, FragmentLayout, Letter) and data dictionary (DataDictionary)

Throws:

ICCException

Since:

10.0.0.0

exportAsset

Downloadable exportAsset(java.util.List assetIDs,
                         java.lang.String packageName)
                         throws ICCException

Export assets as CRX package

Parameters:

assetIDs - assetIDs list of ID of assets to be exported

packageName -

Returns:

Downloadable object having zip File content for all assets

Throws:

ICCException

Since:

10.0.0.0

exportAsset

Downloadable exportAsset(java.util.List assetIDs,
                         java.lang.String packageName,
                         boolean findRelatedAssets)
                         throws ICCException

Export assets as CRX package

Parameters:

assetIDs - assetIDs list of ID of assets to be exported

findRelatedAssets - - when true the assets related to assetIDs are also retrieved and exported. This API is useful if you already have the complete list of assets (including the related assets).

packageName -

Returns:

Downloadable object having zip File content for all assets

Throws:

ICCException

Since:

10.0.0.0

getImportInfo

java.util.List getImportInfo(Downloadable file)
                             throws ICCException

Deprecated. use getImportInfo2

List all the asset and data dictionary to be imported from the file

Parameters:

file - Downloadable object having zip file content

Returns:

list of asset and data dictionary to be imported. List may contains assets (TextModule, ListDataModule, ConditionalDataModule, ImageModule, Form, FragmentLayout, Letter) and data dictionary (DataDictionary).

Throws:

ICCException

Since:

10.0.0.0

getImportInfo2

java.util.Map getImportInfo2(Downloadable file)
                             throws ICCException

List all the assets, categories and data dictionary to be imported from the file.

Parameters:

file - Downloadable object having zip file content

Returns:

map containing following key value pairs:

Key	Value
PackageName	(String) Name of the package.
PackageFileName	(String) Name of the package file.
NewAssets	(List<Object>) List of assets being imported first time on the system.
OldAssets	(List<Object>) List of assets being imported which already exist on the system.

Throws:

ICCException

Since:

10.0.5

importAsset

java.util.List importAsset(Downloadable file)
                           throws ICCException

Deprecated. use importAsset2

Import and install assets

Parameters:

file - Downloadable object having zip file content

Returns:

list of assetID being imported.

Throws:

ICCException

Since:

10.0.0.0

importAsset2

java.util.List importAsset2(java.util.Map packageInfo)
                            throws ICCException

Imports assets.

Parameters:

packageInfo - map containing following key value pairs:

Key	Value
PackageName	(String) Name of the package.
PackageFileName	(String) Name of the package file.
NewAssets	(List<Object>) List of assets being imported first time on the system.
OldAssets	(List<Object>) List of assets being imported which already exist on the system.

Returns:

list of assetID being imported.

Throws:

ICCException

Since:

10.0.5

deletePackage

void deletePackage(java.lang.String packageName)

Deletes the specified package

Parameters:

packageName - name of the package to be deleted.

Throws:

ICCException

Since:

10.0.5

getExportAllInfo

java.util.List getExportAllInfo()
                                throws ICCException

Information about all assets being exported

Returns:

List of Assets and Data Dictinary to be exported. List may contains (TextModule, ListDataModule, ConditionalDataModule, ImageModule, Form, FragmentLayout, Letter) and data dictionary (DataDictionary)

Throws:

ICCException

Since:

10.0.0.0

exportAll

Downloadable exportAll(java.lang.String packageName)
                       throws ICCException

Exports all assets(published/mark-for-published assets) and data dictionary (non-system)

Parameters:

packageName -

Returns:

Downloadable object having zip File content for all assets

Throws:

ICCException

Since:

10.0.0.0