com.canto.cumulus.prefs

Class CatalogAssetRelationList

java.lang.Object

com.canto.cumulus.prefs.BaseManager

com.canto.cumulus.prefs.ListPackManager

com.canto.cumulus.prefs.CatalogAssetRelationList

public class CatalogAssetRelationList
extends ListPackManager

This class manages a list of asset relations stored in a catalog.

Since:

10.0.1

Nested Class Summary

Nested classes/interfaces inherited from class com.canto.cumulus.prefs.BaseManager

BaseManager.PackEntryChangeListener, BaseManager.RegistryEntry

Field Summary

Fields inherited from class com.canto.cumulus.prefs.BaseManager

TYPE_EJP, TYPE_NATIVE

Method Summary

Methods

Modifier and Type	Method and Description
AssetRelation	add(AssetRelation assetRelation) Adds the given asset relation.
AssetRelation	createAssetRelation() Returns a new asset relation with a new ID.
void	delete(AssetRelation assetRelation) Deletes the given asset relation.
AssetRelation	getAssetRelation(GUID assetRelationID) Returns the asset relation with the given ID.
java.util.Set<GUID>	getAssetRelationIDs() Return a mapping of all asset relations, with their internal ID.
java.util.List<AssetRelation>	getAssetRelations() Returns all asset relations contained in this list.
void	moveDown(AssetRelation assetRelation) Moves the given entry one position down.
void	moveDownToEnd(AssetRelation assetRelation) Moves the given entry to the end of the list.
void	moveUp(AssetRelation assetRelation) Moves the given entry one position up.
void	moveUpToTop(AssetRelation assetRelation) Moves the given entry to the top.

Methods inherited from class com.canto.cumulus.prefs.BaseManager

addChangeListener, addChangeListener, addGlobalChangeListener, addPackListener, forgetPush, getPack, isShared, popPack, pushPack, removeChangeListener, removeChangeListener, removeGlobalChangeListener, removePackListener, save, save, toString, writeAsXML

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getAssetRelation

public AssetRelation getAssetRelation(GUID assetRelationID)

Returns the asset relation with the given ID.

Parameters:

assetRelationID - the asset relation to get

Returns:

the asset relation with the given ID or null if it does not exist.

add

public AssetRelation add(AssetRelation assetRelation)

Adds the given asset relation. This makes the given asset relation available.

Parameters:

assetRelation - the asset relation to add

createAssetRelation

public AssetRelation createAssetRelation()

Returns a new asset relation with a new ID.

Returns:

the new asset relation.

delete

public void delete(AssetRelation assetRelation)
            throws CumulusException

Deletes the given asset relation.

Parameters:

assetRelation - the asset relation to delete

Throws:

CumulusException - in case of an error

moveUp

public void moveUp(AssetRelation assetRelation)
            throws JPack.NoSuchElementException

Moves the given entry one position up.

Parameters:

assetRelation - the entry to move up

Throws:

JPack.NoSuchElementException - in case of an invalid entry

moveUpToTop

public void moveUpToTop(AssetRelation assetRelation)
                 throws JPack.NoSuchElementException

Moves the given entry to the top.

Parameters:

assetRelation - the entry to move to the top

Throws:

JPack.NoSuchElementException - in case of an invalid entry

moveDown

public void moveDown(AssetRelation assetRelation)
              throws JPack.NoSuchElementException

Moves the given entry one position down.

Parameters:

assetRelation - the entry to move down

Throws:

JPack.NoSuchElementException - in case of an invalid entry

moveDownToEnd

public void moveDownToEnd(AssetRelation assetRelation)
                   throws JPack.NoSuchElementException

Moves the given entry to the end of the list.

Parameters:

assetRelation - the entry to move to the end

Throws:

JPack.NoSuchElementException - in case of an invalid entry

getAssetRelations

public java.util.List<AssetRelation> getAssetRelations()

Returns all asset relations contained in this list.

Returns:

all asset relations of this list

getAssetRelationIDs

public java.util.Set<GUID> getAssetRelationIDs()

Return a mapping of all asset relations, with their internal ID.

Returns:

mapping of all asset relations