com.adobe.icc.services.api
Interface PublishService

public interface PublishService

Service interface for publish service.

Method Summary

java.util.List	getAllAssets(int assetState) Fetches all the assets present on the server in the given state.
boolean	isAnyModifiedAssetPresent() Returns true, if there are any Modified assets found on the server.
void	markAllAssetsRTP() Finds all the 'Modified' assets present on the server and marks them as 'Ready To Publish'
void	publishAllAssets() Publishes all the 'Ready To Publish' marked assets present on the server.
void	publishAssetObjects(java.util.List assetsToPublish) For internal use.
void	publishAssets(java.util.List assetsToPublish) Publish the assets and categories in the given list.
java.util.List	retrieveRelatedAssetsForActivation(java.lang.String assetId) Returns the list of related assets, which should be published along with this asset.

Method Detail

retrieveRelatedAssetsForActivation

java.util.List retrieveRelatedAssetsForActivation(java.lang.String assetId)
                                                  throws ICCException

Returns the list of related assets, which should be published along with this asset. The list contains following assets: 1. All the child assets in ReadyToPublish or Modified state. 2. Parent assets which have been published at least once and their state is ReadyToPublish or Modified. 3. For any parent or child asset their child and parent assets are retrieved recursively as per logic in 1 and 2. 4. All the unpublished categories being referred in any of assets found in step 1 - 3, will also be returned in the list. UI is not required to show these categories in the list of assets being published, however these categories should be passed back to the publishAssets API.

Parameters:

assetId - Id of the asset for which dependency is required to be computed.

Returns:

list of related assets that needs to be published.

Throws:

ICCException

publishAssets

void publishAssets(java.util.List assetsToPublish)
                   throws ICCException

Publish the assets and categories in the given list. All the assets should be in ReadyToPublish state otherwise an exception is thrown. No check is done on the state of category.

Parameters:

assetsToPublish - id of assets and categories required to be published.

Throws:

ICCException

publishAssetObjects

void publishAssetObjects(java.util.List assetsToPublish)
                         throws ICCException

For internal use.

Throws:

ICCException

isAnyModifiedAssetPresent

boolean isAnyModifiedAssetPresent()
                                  throws ICCException

Returns true, if there are any Modified assets found on the server.

Returns:

Throws:

ICCException

getAllAssets

java.util.List getAllAssets(int assetState)
                            throws ICCException

Fetches all the assets present on the server in the given state.

Parameters:

assetState - possible values Modified, Ready To Publish and Publish (integer value 3, 4 and 5 respectively)

Returns:

Throws:

ICCException

markAllAssetsRTP

void markAllAssetsRTP()
                      throws ICCException

Finds all the 'Modified' assets present on the server and marks them as 'Ready To Publish'

Throws:

ICCException

publishAllAssets

void publishAllAssets()
                      throws ICCException

Publishes all the 'Ready To Publish' marked assets present on the server. The assets are only published if there is no 'Modified' asset present on the server else an error is reported.

Throws:

ICCException