BeatQueryParameter (edoras one Javadoc)

java.lang.Object
- java.lang.Enum<BeatQueryParameter>
- - com.edorasware.commons.core.beat.BeatQueryParameter

All Implemented Interfaces:: QueryParameter, Serializable, Comparable<BeatQueryParameter>

public enum BeatQueryParameter
extends Enum<BeatQueryParameter>
implements QueryParameter

Enum Constant Summary

Enum Constants
Enum Constant and Description
`CREATION_TIME`
`DESCRIPTION`
`EVENT_SUB_TYPE`
`EVENT_TYPE`
`EXTERNAL_ID`
`GLOBAL_ID`
`GLOBAL_ORDER_INDEX`
`ID`
`NAME`
`PARENT_ID`
`PROVIDER_ID`
`ROOT_ID`
`SOURCE_FIELD_ID`
`SOURCE_ID`
`TENANT_ID`
`TYPE`
`UPDATE_TIME`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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 BeatQueryParameter`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static BeatQueryParameter[]`	`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 BeatQueryParameter ID
```
  - GLOBAL_ID
```
public static final BeatQueryParameter GLOBAL_ID
```
  - EXTERNAL_ID
```
public static final BeatQueryParameter EXTERNAL_ID
```
  - PROVIDER_ID
```
public static final BeatQueryParameter PROVIDER_ID
```
  - TENANT_ID
```
public static final BeatQueryParameter TENANT_ID
```
  - NAME
```
public static final BeatQueryParameter NAME
```
  - DESCRIPTION
```
public static final BeatQueryParameter DESCRIPTION
```
  - CREATION_TIME
```
public static final BeatQueryParameter CREATION_TIME
```
  - UPDATE_TIME
```
public static final BeatQueryParameter UPDATE_TIME
```
  - TYPE
```
public static final BeatQueryParameter TYPE
```
  - GLOBAL_ORDER_INDEX
```
public static final BeatQueryParameter GLOBAL_ORDER_INDEX
```
  - EVENT_TYPE
```
public static final BeatQueryParameter EVENT_TYPE
```
  - EVENT_SUB_TYPE
```
public static final BeatQueryParameter EVENT_SUB_TYPE
```
  - ROOT_ID
```
public static final BeatQueryParameter ROOT_ID
```
  - PARENT_ID
```
public static final BeatQueryParameter PARENT_ID
```
  - SOURCE_ID
```
public static final BeatQueryParameter SOURCE_ID
```
  - SOURCE_FIELD_ID
```
public static final BeatQueryParameter SOURCE_FIELD_ID
```
- Method Detail
  - values
```
public static BeatQueryParameter[] 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 (BeatQueryParameter c : BeatQueryParameter.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static BeatQueryParameter 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

Enum BeatQueryParameter

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

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

Enum Constant Detail

ID

GLOBAL_ID

EXTERNAL_ID

PROVIDER_ID

TENANT_ID

NAME

DESCRIPTION

CREATION_TIME

UPDATE_TIME

TYPE

GLOBAL_ORDER_INDEX

EVENT_TYPE

EVENT_SUB_TYPE

ROOT_ID

PARENT_ID

SOURCE_ID

SOURCE_FIELD_ID

Method Detail

values

valueOf

hasTypeAwareIdValue