com.highdeal.hci

Enum TableScope

java.lang.Object

java.lang.Enum<TableScope>

com.highdeal.hci.TableScope

All Implemented Interfaces:

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

public enum TableScope
extends java.lang.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

Enum Constant Summary

Enum Constants

Enum Constant and 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 and Description
static void	addCatalogTableScopeSpecificFormula(SearchFilterModel filter) Add a CATALOG table scope specific formula if the filter does not contain any.
java.lang.String	getPrettyName() Gets the XML pretty name of the table scope.
static TableScope	getTableScopeFromPrettyName(java.lang.String prettyName) Gets the TableScope instance corresponding to the pretty name.
static TableScope	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static TableScope[]	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

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 Detail

values

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

Returns:

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

valueOf

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

getPrettyName

public java.lang.String getPrettyName()

Gets the XML pretty name of the table scope.

Returns:

the name of the table scope

getTableScopeFromPrettyName

public static final TableScope getTableScopeFromPrettyName(java.lang.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