Package com.orchestranetworks.addon.dama.externalmanagement

Interface ExternalManager

public interface ExternalManager

Provides methods to perform operations on digital assets located in an externally managed system.

Since:

1.8.0

Method Summary

Modifier and Type	Method	Description
ExternalDigitalAsset	createAsset(ExternalUploadAssetRequest request)	Creates a new ExternalDigitalAsset following the ExternalUploadAssetRequest.
ExternalDigitalAsset	createAssetVersion(ExternalUploadAssetRequest request)	Creates a new digital asset version.
OperationExecutionStatus	deleteAsset(ExternalSingularRequest request, boolean isPhysicalDelete)	Deletes a digital asset.
OperationExecutionStatus	deleteAssetVersion(ExternalSingularRequest request)	Deletes a digital asset version.
ExternalDigitalAsset	getAsset(ExternalSingularRequest request)	Returns the digital asset by external request.
List<ExternalDigitalAsset>	getAssets(ExternalPluralRequest request)	Returns the list of digital assets by external request.
ExternalDigitalAssetVersionBean	getAssetVersionBean(ExternalSingularRequest request)	Returns the digital asset version bean by external request.
MediaContent	getMediaContentOfAsset(ExternalSingularRequest request)	Gets the media content of a digital asset.
MediaContent	getMediaContentOfAssetVersion(ExternalSingularRequest request)	Gets the media content of a digital asset version.
ExternalTagResult	getTags(ExternalCommonRequest request)	Returns the tag result.
ExternalSearchAssetsResult	searchAssets(ExternalSearchRequest request)	Searches for digital assets using an external search request.
OperationExecutionStatus	updateAsset(ExternalCommonRequest request, ExternalDigitalAsset asset)	Updates a digital asset.
OperationExecutionStatus	updateAssetVersion(ExternalCommonRequest request, ExternalDigitalAsset assetVersion)	Updates a digital asset version.

Method Details

createAsset

ExternalDigitalAsset createAsset(ExternalUploadAssetRequest request)

Creates a new ExternalDigitalAsset following the ExternalUploadAssetRequest.

Parameters:

request - the upload asset request

Returns:

the digital asset

createAssetVersion

ExternalDigitalAsset createAssetVersion(ExternalUploadAssetRequest request)

Creates a new digital asset version.

Parameters:

request - the upload asset request

Returns:

the digital asset

deleteAsset

OperationExecutionStatus deleteAsset(ExternalSingularRequest request,
 boolean isPhysicalDelete)

Deletes a digital asset.

Parameters:

request - the request

isPhysicalDelete - determines whether the asset is physically deleted from the system

Returns:

the operation execution status

deleteAssetVersion

OperationExecutionStatus deleteAssetVersion(ExternalSingularRequest request)

Deletes a digital asset version.

Parameters:

request - the request

Returns:

the operation execution status

getAssets

List<ExternalDigitalAsset> getAssets(ExternalPluralRequest request)

Returns the list of digital assets by external request.

Parameters:

request - the request

Returns:

the list of digital assets

getAsset

ExternalDigitalAsset getAsset(ExternalSingularRequest request)
                       throws DAMException

Returns the digital asset by external request.

Parameters:

request - the request

Returns:

the digital asset

Throws:

DAMException

getAssetVersionBean

ExternalDigitalAssetVersionBean getAssetVersionBean(ExternalSingularRequest request)

Returns the digital asset version bean by external request.

Parameters:

request - the request

Returns:

the digital asset version

getMediaContentOfAsset

MediaContent getMediaContentOfAsset(ExternalSingularRequest request)

Gets the media content of a digital asset.

Parameters:

request - the asset request

Returns:

the media content

getMediaContentOfAssetVersion

MediaContent getMediaContentOfAssetVersion(ExternalSingularRequest request)

Gets the media content of a digital asset version.

Parameters:

request - the asset request

Returns:

the media content

getTags

ExternalTagResult getTags(ExternalCommonRequest request)

Returns the tag result.

Parameters:

request - the request

Returns:

the tag result

searchAssets

ExternalSearchAssetsResult searchAssets(ExternalSearchRequest request)

Searches for digital assets using an external search request.

Parameters:

request - the search request

Returns:

the list of digital assets

updateAsset

OperationExecutionStatus updateAsset(ExternalCommonRequest request,
 ExternalDigitalAsset asset)

Updates a digital asset.

Parameters:

request - the request

asset - the asset

Returns:

the operation execution status

updateAssetVersion

OperationExecutionStatus updateAssetVersion(ExternalCommonRequest request,
 ExternalDigitalAsset assetVersion)

Updates a digital asset version.

Parameters:

request - the request

assetVersion - the asset

Returns:

the operation execution status