com.canto.cumulus.constants

Enum CatalogingFlag

java.lang.Object

java.lang.Enum<CatalogingFlag>

com.canto.cumulus.constants.CatalogingFlag

All Implemented Interfaces:

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

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

This enum specified the available cataloging option flags. They can be used when calling ItemCollection.catalogAsset(com.canto.cumulus.Asset, String, String, java.util.EnumSet, com.canto.cumulus.events.CatalogingListener) or one of the other cataloging methods. These option flags override the settings of the used asset handling set or the user setting for counting assets. Usually you don't need to use these flags.

Since:

8.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
CATALOGING_FLAG_SKIP_COUNTING_ASSETS Do not count assets.
CATALOGING_FLAG_SKIP_FILTERS Skip all available filters when cataloging.
CATALOGING_FLAG_SKIP_SUBASSETS Do not catalog sub assets.
CATALOGING_FLAG_SKIP_TRY_TO_CHECKIN Do not try to checkin the asset.

Method Summary

Methods

Modifier and Type	Method and Description
static java.util.EnumSet<CatalogingFlag>	findAll(int id) Finds all flags that are encoded into the given id.
static CatalogingFlag	findType(int id) Finds the exact flag for the given flag id or throws an exception if the given id is invalid.
static int	getAll(java.util.EnumSet<CatalogingFlag> flags) Encodes the given set of flags into a single id.
static CatalogingFlag	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CatalogingFlag[]	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

CATALOGING_FLAG_SKIP_FILTERS

public static final CatalogingFlag CATALOGING_FLAG_SKIP_FILTERS

Skip all available filters when cataloging.

CATALOGING_FLAG_SKIP_SUBASSETS

public static final CatalogingFlag CATALOGING_FLAG_SKIP_SUBASSETS

Do not catalog sub assets. Eg. pages of a PDF document.

CATALOGING_FLAG_SKIP_COUNTING_ASSETS

public static final CatalogingFlag CATALOGING_FLAG_SKIP_COUNTING_ASSETS

Do not count assets.

CATALOGING_FLAG_SKIP_TRY_TO_CHECKIN

public static final CatalogingFlag CATALOGING_FLAG_SKIP_TRY_TO_CHECKIN

Do not try to checkin the asset.

Since:

10.1.3

Method Detail

values

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

Returns:

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

valueOf

public static CatalogingFlag 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

findType

public static CatalogingFlag findType(int id)

Finds the exact flag for the given flag id or throws an exception if the given id is invalid.

Parameters:

id - wanted id of the flag to find

Returns:

Finds the exact flag for the given flag id or throws an exception if the given id is invalid

findAll

public static java.util.EnumSet<CatalogingFlag> findAll(int id)

Finds all flags that are encoded into the given id.

Parameters:

id - flag containing multiple cataloging flag values

Returns:

the found set of flags

See Also:

getAll(java.util.EnumSet)

getAll

public static int getAll(java.util.EnumSet<CatalogingFlag> flags)

Encodes the given set of flags into a single id.

Parameters:

flags - flags to encode

Returns:

single id representing all given flags

See Also:

findAll(int)