com.fatwire.mda
Interface DimensionableAssetManager

public interface DimensionableAssetManager

This interface provides a mechanism for manipulating Dimensional assets.

Since:

17 mai 2006 14:58:31

Method Summary

AssetId	getRelative(AssetId asset, java.lang.String dimensionName) Given an identifier for an asset, retrieve the asset that is semantically equivalent to the input asset whose dimension is the specified value.
java.util.Collection<AssetId>	getRelatives(AssetId asset, DimensionFilterInstance filter) Given an identifier for an asset, retrieve all of the assets that are its semantic equivalents.
java.util.Collection<AssetId>	getRelatives(AssetId asset, DimensionFilterInstance filter, java.lang.String group) Given an identifier for an asset, retrieve all of the assets that are its semantic equivalents within the specified group.

Method Detail

getRelatives

java.util.Collection<AssetId> getRelatives(AssetId asset,
                                           DimensionFilterInstance filter)

Given an identifier for an asset, retrieve all of the assets that are its semantic equivalents.

Parameters:

asset - Identifier of an asset for which all relatives will be retrieved.

filter - Optional filter to constrain list of returned ids. A null value is permitted: the results will not be filtered.

Returns:

Collection of asset ids. Depending on the filter, the input asset may be present in the returned collection.

getRelatives

java.util.Collection<AssetId> getRelatives(AssetId asset,
                                           DimensionFilterInstance filter,
                                           java.lang.String group)

Given an identifier for an asset, retrieve all of the assets that are its semantic equivalents within the specified group.

This is a convenience method for further filtering relatives. Its behaviour is equivalent to calling DimensionableAssetManager.getRelatives(AssetId,DimensionFilterInstance) then removing assets whose dimensions are not members of the specified group.

Parameters:

asset - Identifier of an asset for which all relatives will be retrieved.

filter - Optional filter to constrain list of returned ids. A null value is permitted: the results will not be filtered.

group - Optional Dimension group that logically unites disparate dimensions

Returns:

Collection of asset ids. Depending on the filter, the input asset may be present in the returned collection.

getRelative

AssetId getRelative(AssetId asset,
                    java.lang.String dimensionName)

Given an identifier for an asset, retrieve the asset that is semantically equivalent to the input asset whose dimension is the specified value.

Parameters:

asset - Identifier of an asset for which the relative will be retrieved.

dimensionName - the name of the dimension of the asset to return

Returns:

the asset ID of the relative (or the input asset id if it is already in the same dimension or null if no match is found.

Throws:

java.lang.IllegalArgumentException - if the input dimension name does not exist.