Package com.highdeal.hci

Enum Class TableScope

java.lang.Object

java.lang.Enum<TableScope>

com.highdeal.hci.TableScope

All Implemented Interfaces:

Serializable, Comparable<TableScope>, Constable

public enum TableScope
extends Enum<TableScope>

Enumeration specifying the scope of a table.
A charge plan status can be:

1. catalog: only tables own by a catalog
2. agreement: only tables attached to an agreement id
3. both: all the tables

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AGREEMENT	Only tables attached to an agreement id
BOTH	All the tables
CATALOG	Only tables own by a catalog

Method Summary

Modifier and Type	Method	Description
static final void	addCatalogTableScopeSpecificFormula(SearchFilterModel filter)	Add a CATALOG table scope specific formula if the filter does not contain any.
String	getPrettyName()	Gets the XML pretty name of the table scope.
static final TableScope	getTableScopeFromPrettyName(String prettyName)	Gets the TableScope instance corresponding to the pretty name.
static TableScope	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TableScope[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CATALOG

public static final TableScope CATALOG

Only tables own by a catalog

AGREEMENT

public static final TableScope AGREEMENT

Only tables attached to an agreement id

BOTH

public static final TableScope BOTH

All the tables

Method Details

values

public static TableScope[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static TableScope valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getPrettyName

public String getPrettyName()

Gets the XML pretty name of the table scope.

Returns:

the name of the table scope

getTableScopeFromPrettyName

public static final TableScope getTableScopeFromPrettyName(String prettyName)

Gets the TableScope instance corresponding to the pretty name.

Parameters:

prettyName - the name of the table scope

Returns:

the TableScope corresponding to the pretty name. null otherwise.

addCatalogTableScopeSpecificFormula

public static final void addCatalogTableScopeSpecificFormula(SearchFilterModel filter)

Add a CATALOG table scope specific formula if the filter does not contain any.

Parameters:

filter - the filter that must be enriched with a default table scope specific formula