com.canto.cumulus.constants

Enum CollectionType

java.lang.Object

java.lang.Enum<CollectionType>

com.canto.cumulus.constants.CollectionType

All Implemented Interfaces:

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

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

This enum specifies all available collection type for a server-side collection.

Since:

8.0

See Also:

MultiRecordItemCollection.save(String, boolean, CollectionType)

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTO_COLLECTION The type for a collection that is automatically opened and saved by a client.
COLLECTION_BASKET The type for a collection containing a collection basket.
CUSTOM_COLLECTION The type for a collection to be used by integrators which will not be shown by Cumulus client applications.
NORMAL_COLLECTION The type for a normal collection (manually created and opened).
PIN_COLLECTION The type for a PIN collection.
UPLOAD_COLLECTION The type for a collection that dynamically finds all records that have been uploaded into this collection.

Method Summary

Methods

Modifier and Type	Method and Description
static CollectionType	findType(int id) Finds the collection type for the given id.
int	getID() Returns the id for this collection type.
static CollectionType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CollectionType[]	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

NORMAL_COLLECTION

public static final CollectionType NORMAL_COLLECTION

The type for a normal collection (manually created and opened).

AUTO_COLLECTION

public static final CollectionType AUTO_COLLECTION

The type for a collection that is automatically opened and saved by a client.

COLLECTION_BASKET

public static final CollectionType COLLECTION_BASKET

The type for a collection containing a collection basket.

PIN_COLLECTION

public static final CollectionType PIN_COLLECTION

The type for a PIN collection. Usually only used by the web clients.

Since:

8.1

CUSTOM_COLLECTION

public static final CollectionType CUSTOM_COLLECTION

The type for a collection to be used by integrators which will not be shown by Cumulus client applications. You can use the CustomData instance provided by CollectionSet.getCustomData() to store additional information with the collection.

Since:

8.1.3

UPLOAD_COLLECTION

public static final CollectionType UPLOAD_COLLECTION

The type for a collection that dynamically finds all records that have been uploaded into this collection.

Since:

9.0

Method Detail

values

public static CollectionType[] 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 (CollectionType c : CollectionType.values())
    System.out.println(c);

Returns:

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

valueOf

public static CollectionType 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 collection type.

Returns:

id

See Also:

findType(int)

findType

public static CollectionType findType(int id)

Finds the collection type for the given id.

Parameters:

id - wanted id

Returns:

found collection type or NORMAL_COLLECTION if the given id cannot be found

See Also:

getID()