com.orchestranetworks.addon.dama.ext.drivemanager

Interface DriveManager

public interface DriveManager

Defines a DriveManager to perform operations on digital assets.

Since:

1.6.0

Method Summary

Modifier and Type	Method and Description
DigitalAsset	create(com.orchestranetworks.addon.dama.ext.bean.GeneralDigitalAssetSpec assetSpec) Creates the new DigitalAsset following the DigitalAssetSpec.
DigitalAssetVersion	create(com.orchestranetworks.addon.dama.ext.bean.GeneralDigitalAssetVersionSpec versionSpec) Creates the new DigitalAssetVersion following DigitalAssetSpec.
OperationExecutionStatus	delete(DigitalAssetKey key) Deletes a digital asset.
OperationExecutionStatus	delete(DigitalAssetVersionKey key) Deletes a digital asset version.
DigitalAsset	getDigitalAsset(DigitalAssetKey key) Deprecated. use getDigitalAssetOrNull(DigitalAssetKey) instead.
DigitalAsset	getDigitalAssetOrNull(DigitalAssetKey key) Returns the digital asset by digital asset key or return null if the asset does not exist.
List<DigitalAsset>	getDigitalAssets() Returns the active digital assets in the drive.
MediaContent	getMediaContent(DigitalAsset asset) Gets the media content of a digital asset.
MediaContent	getMediaContent(DigitalAssetVersion version) Gets the media content of a version.
List<DigitalAsset>	search(SearchFilter searchFilter) Searches for a digital asset using a search filter.
OperationExecutionStatus	update(DigitalAsset asset) Updates a digital asset.
OperationExecutionStatus	update(DigitalAssetVersion version) Updates a digital asset version.

Method Detail

create

DigitalAsset create(com.orchestranetworks.addon.dama.ext.bean.GeneralDigitalAssetSpec assetSpec)
             throws DAMException

Creates the new DigitalAsset following the DigitalAssetSpec.

Parameters:

assetSpec - the specification of the new digital asset

Returns:

the digital asset

Throws:

DAMException

create

DigitalAssetVersion create(com.orchestranetworks.addon.dama.ext.bean.GeneralDigitalAssetVersionSpec versionSpec)
                    throws DAMException

Creates the new DigitalAssetVersion following DigitalAssetSpec.

Parameters:

versionSpec - the specification of the new digital asset version

Returns:

the digital asset version

Throws:

DAMException

delete

OperationExecutionStatus delete(DigitalAssetKey key)

Deletes a digital asset.

Parameters:

key - the digital asset key

Returns:

the operation execution status

delete

OperationExecutionStatus delete(DigitalAssetVersionKey key)

Deletes a digital asset version.

Parameters:

key - the digital asset version key

Returns:

the operation execution status

update

OperationExecutionStatus update(DigitalAsset asset)

Updates a digital asset.

Parameters:

asset - the asset

Returns:

the operation execution status

update

OperationExecutionStatus update(DigitalAssetVersion version)

Updates a digital asset version.

Parameters:

version - the version

Returns:

the operation execution status

search

List<DigitalAsset> search(SearchFilter searchFilter)
                   throws DAMException

Searches for a digital asset using a search filter.

Parameters:

searchFilter - the search filter

Returns:

the list of digital assets

Throws:

DAMException

getDigitalAssets

List<DigitalAsset> getDigitalAssets()
                             throws DAMException

Returns the active digital assets in the drive.

Throws:

DAMException

getDigitalAsset

DigitalAsset getDigitalAsset(DigitalAssetKey key)
                      throws DAMException

Deprecated. use getDigitalAssetOrNull(DigitalAssetKey) instead.

Returns the digital asset by digital asset key.

Parameters:

key - the key

Returns:

the digital asset

Throws:

DAMException

getDigitalAssetOrNull

DigitalAsset getDigitalAssetOrNull(DigitalAssetKey key)
                            throws DAMException

Returns the digital asset by digital asset key or return null if the asset does not exist.

Parameters:

key - the key

Returns:

the digital asset or null

Throws:

DAMException

Since:

1.8.9

getMediaContent

MediaContent getMediaContent(DigitalAsset asset)
                      throws DAMException

Gets the media content of a digital asset.

Parameters:

asset - the digital asset

Returns:

the media content

Throws:

DAMException

getMediaContent

MediaContent getMediaContent(DigitalAssetVersion version)
                      throws DAMException

Gets the media content of a version.

Parameters:

version - the digital asset version

Returns:

the media content

Throws:

DAMException