com.canto.cumulus.modules

Interface AssetStorageModule

All Superinterfaces:

Module

public interface AssetStorageModule
extends Module

The Module object exposes the common methods supported by asset storage modules.

Since:

EJaP 6.0.0

Field Summary

Fields inherited from interface com.canto.cumulus.modules.Module

MODULE_APPLICATION, MODULE_ASSET_ACTION_PACKER, MODULE_ASSET_ACTION_PROCESSOR, MODULE_ASSET_ACTION_SAVER, MODULE_ASSET_METADATA, MODULE_ASSET_PROCESSOR, MODULE_ASSET_STORAGE, MODULE_FILTER, MODULE_TYPE_MASK_ALL

Method Summary

Methods

Modifier and Type	Method and Description
Asset	browseForAsset(CumulusSession cumulusSession, boolean allowContainer, boolean allowAsset, java.lang.String title) Bring up a dialog to allow the user to select a single asset.
Asset	browseForAsset(CumulusSession cumulusSession, boolean allowContainer, boolean allowAsset, java.lang.String title, java.lang.String defaultNameForContainer) Bring up a dialog to allow the user to select a single asset.
boolean	canBrowseForAsset(boolean allowContainer, boolean allowAsset) Check whether this AssetStorage can bring up a dialog to select a single asset.
byte[]	createAssetReferenceData(CumulusSession cumulusSession, Asset asset) Create AssetReference part data for the given asset if possible.
boolean	isValidExclusiveAssetReferenceForCatalog(CumulusSession cumulusSession, AssetReferencePart assetReferencePart, java.lang.String catalogName) Return whether the given AssetReference is valid to be used as an exclusive central asset location for the given catalog.
Asset	resolveAssetReferenceData(CumulusSession cumulusSession, byte[] data, boolean showUI, Asset container) Returns the asset found for the given asset reference data.

Methods inherited from interface com.canto.cumulus.modules.Module

getAvailableCategoryFields, getAvailableRecordFields, getID, getName, getName, getType, hasAboutDialog, hasPreferencesDialog, isNativeModule, showAboutDialog, showPreferencesDialog

Method Detail

canBrowseForAsset

boolean canBrowseForAsset(boolean allowContainer,
                        boolean allowAsset)

Check whether this AssetStorage can bring up a dialog to select a single asset.

Parameters:

allowContainer - allow selecting an asset container

allowAsset - allow selecting an asset that is not a container

Returns:

true if the AssetStorage module can browse for the specified asset type.

browseForAsset

Asset browseForAsset(CumulusSession cumulusSession,
                   boolean allowContainer,
                   boolean allowAsset,
                   java.lang.String title)

Bring up a dialog to allow the user to select a single asset.

Parameters:

cumulusSession - the CumulusSession to use

allowContainer - allow selecting an asset container

allowAsset - allow selecting an asset that is not a container

title - dialog title of the upcoming dialog

Returns:

The asset object for the selected asset. Return null if no asset was selected.

Since:

8.5

browseForAsset

Asset browseForAsset(CumulusSession cumulusSession,
                   boolean allowContainer,
                   boolean allowAsset,
                   java.lang.String title,
                   java.lang.String defaultNameForContainer)

Bring up a dialog to allow the user to select a single asset.

Parameters:

cumulusSession - the CumulusSession to use

allowContainer - allow selecting an asset container

allowAsset - allow selecting an asset that is not a container

title - dialog title of the upcoming dialog

defaultNameForContainer - if the user selects a container asset this is used as the default name for the container to be created

Returns:

The asset object for the selected asset. Return null if no asset was selected.

Since:

8.5

createAssetReferenceData

byte[] createAssetReferenceData(CumulusSession cumulusSession,
                              Asset asset)

Create AssetReference part data for the given asset if possible. If this AssetStorage can not create reference data for this kind of asset it returns null.

Parameters:

cumulusSession - the session to use for the AssetReference data to be created

asset - The asset to create reference information for

Returns:

The asset reference data for the given asset. It returns null if it can not create asset reference data.

Since:

8.0

resolveAssetReferenceData

Asset resolveAssetReferenceData(CumulusSession cumulusSession,
                              byte[] data,
                              boolean showUI,
                              Asset container)

Returns the asset found for the given asset reference data.

Parameters:

cumulusSession - the session to use for the Asset to be created

data - Asset reference data

showUI - Indicates whether the module can show user interface (only evaluated when the Cumulus Java Classes are running with user interface)

container - The container specified for sub assets (may be null)

Returns:

The resolved asset or null

Since:

8.0

isValidExclusiveAssetReferenceForCatalog

boolean isValidExclusiveAssetReferenceForCatalog(CumulusSession cumulusSession,
                                               AssetReferencePart assetReferencePart,
                                               java.lang.String catalogName)

Return whether the given AssetReference is valid to be used as an exclusive central asset location for the given catalog. To be valid the location should not be used by any other catalog as an exclusive central asset location.

Parameters:

assetReferencePart - the AssetReference information to be checked

Returns:

true if the given AssetReference can be used for the given catalog's exclusive central asset location.

Since:

8.5