com.edorasware.commons.core.beat

Enum BeatVariableQueryParameter

java.lang.Object

java.lang.Enum<BeatVariableQueryParameter>

com.edorasware.commons.core.beat.BeatVariableQueryParameter

All Implemented Interfaces:

QueryParameter, Serializable, Comparable<BeatVariableQueryParameter>

public enum BeatVariableQueryParameter
extends Enum<BeatVariableQueryParameter>
implements QueryParameter

Query parameters representing fields of a Beat-specific Variable.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ID
OBJECT_ID
OBJECT_ID_REF
VARIABLE_NAME
VARIABLE_TYPE
VARIABLE_VALUE_DOUBLE_TARGET_TYPE
VARIABLE_VALUE_LARGE_STRING_TARGET_TYPE
VARIABLE_VALUE_LONG_TARGET_TYPE
VARIABLE_VALUE_STRING_TARGET_TYPE

Method Summary

Modifier and Type	Method and Description
boolean	hasTypeAwareIdValue() Signals whether a value that belongs to this query parameter is a type-aware Id string.
static BeatVariableQueryParameter	valueOf(String name) Returns the enum constant of this type with the specified name.
static BeatVariableQueryParameter[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.edorasware.commons.core.query.QueryParameter

name

Enum Constant Detail

ID

public static final BeatVariableQueryParameter ID

VARIABLE_NAME

public static final BeatVariableQueryParameter VARIABLE_NAME

VARIABLE_TYPE

public static final BeatVariableQueryParameter VARIABLE_TYPE

VARIABLE_VALUE_LONG_TARGET_TYPE

public static final BeatVariableQueryParameter VARIABLE_VALUE_LONG_TARGET_TYPE

VARIABLE_VALUE_DOUBLE_TARGET_TYPE

public static final BeatVariableQueryParameter VARIABLE_VALUE_DOUBLE_TARGET_TYPE

VARIABLE_VALUE_STRING_TARGET_TYPE

public static final BeatVariableQueryParameter VARIABLE_VALUE_STRING_TARGET_TYPE

VARIABLE_VALUE_LARGE_STRING_TARGET_TYPE

public static final BeatVariableQueryParameter VARIABLE_VALUE_LARGE_STRING_TARGET_TYPE

OBJECT_ID_REF

public static final BeatVariableQueryParameter OBJECT_ID_REF

OBJECT_ID

public static final BeatVariableQueryParameter OBJECT_ID

Method Detail

values

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

Returns:

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

valueOf

public static BeatVariableQueryParameter valueOf(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:

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

NullPointerException - if the argument is null

hasTypeAwareIdValue

public boolean hasTypeAwareIdValue()

Description copied from interface: QueryParameter

Signals whether a value that belongs to this query parameter is a type-aware Id string. This flag is required to properly render parameter values in case of ids that are stored as strings in a format contains the actual id value as well as the type of the id.

Specified by:

hasTypeAwareIdValue in interface QueryParameter

Returns:

true if its value is a type-aware Id string