com.canto.cumulus.constants

Enum CentralAssetLocationMode

java.lang.Object

java.lang.Enum<CentralAssetLocationMode>

com.canto.cumulus.constants.CentralAssetLocationMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CentralAssetLocationMode>

public enum CentralAssetLocationMode
extends java.lang.Enum<CentralAssetLocationMode>

This enum specifies all available modes for the central asset location configuration of a catalog.

Since:

8.0

See Also:

Catalog.getCentralAssetLocationMode()

Enum Constant Summary

Enum Constants

Enum Constant and Description
COPY_ASSET_TO_COLLECTION_FOLDER_ALWAYS The central asset location should always be used.
COPY_ASSET_TO_COLLECTION_FOLDER_ALWAYS_AND_EXCLUSIVE The central asset location should always be used and is exclusive for the catalog.
COPY_ASSET_TO_COLLECTION_FOLDER_IF_CONFIGURED_IN_ASSET_HANDLING_SET The central asset location should only be used if the used asset handling set is configured to use it.
DONT_COPY_ASSET_TO_COLLECTION_FOLDER The catalog does not use a central asset location.

Method Summary

Methods

Modifier and Type	Method and Description
static CentralAssetLocationMode	find(int id) Finds the mode for the given id.
int	getID() Returns the id for this mode.
static CentralAssetLocationMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CentralAssetLocationMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DONT_COPY_ASSET_TO_COLLECTION_FOLDER

public static final CentralAssetLocationMode DONT_COPY_ASSET_TO_COLLECTION_FOLDER

The catalog does not use a central asset location.

COPY_ASSET_TO_COLLECTION_FOLDER_IF_CONFIGURED_IN_ASSET_HANDLING_SET

public static final CentralAssetLocationMode COPY_ASSET_TO_COLLECTION_FOLDER_IF_CONFIGURED_IN_ASSET_HANDLING_SET

The central asset location should only be used if the used asset handling set is configured to use it.

COPY_ASSET_TO_COLLECTION_FOLDER_ALWAYS

public static final CentralAssetLocationMode COPY_ASSET_TO_COLLECTION_FOLDER_ALWAYS

The central asset location should always be used.

COPY_ASSET_TO_COLLECTION_FOLDER_ALWAYS_AND_EXCLUSIVE

public static final CentralAssetLocationMode COPY_ASSET_TO_COLLECTION_FOLDER_ALWAYS_AND_EXCLUSIVE

The central asset location should always be used and is exclusive for the catalog. This means that every record of the catalog has an asset at the central asset location and deleting a record from the catalog would also delete the according asset in the central asset location.

Method Detail

values

public static CentralAssetLocationMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CentralAssetLocationMode c : CentralAssetLocationMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CentralAssetLocationMode valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getID

public int getID()

Returns the id for this mode.

Returns:

id

find

public static CentralAssetLocationMode find(int id)

Finds the mode for the given id.

Parameters:

id - wanted id

Returns:

the found mode or an EnumConstantNotPresentException if the id could not be found