LocationLevelId (SIH-Adagio :: Core 3.5.6 API)

Object
- Enum<LocationLevelId>
- - LocationLevelId

All Implemented Interfaces:: AdagioEnumerationDef<Integer>, Serializable, Comparable<LocationLevelId>

public enum LocationLevelId
extends Enum<LocationLevelId>
implements Serializable, AdagioEnumerationDef<Integer>

Enum Constant Summary

Enum Constants
Enum Constant and Description
`CRIEE` TODO: Model Documentation for Enumeration Literal CRIEE value 7
`DEPARTEMENT` TODO: Model Documentation for Enumeration Literal DEPARTEMENT value 32
`FAO_ZONE` TODO: Model Documentation for Enumeration Literal FAO_ZONE value 101
`PAYS_ISO3` TODO: Model Documentation for Enumeration Literal PAYS_ISO3 value 21
`PORT` TODO: Model Documentation for Enumeration Literal PORT value 6
`QUARTIER` TODO: Model Documentation for Enumeration Literal QUARTIER value 13
`RECTANGLE_CGPM_GFCM` TODO: Model Documentation for Enumeration Literal RECTANGLE_CGPM_GFCM value 145
`RECTANGLE_STATISTIQUE` TODO: Model Documentation for Enumeration Literal RECTANGLE_STATISTIQUE value 113
`REGION` TODO: Model Documentation for Enumeration Literal REGION value 31
`SCIENTIFIC_CRUISE_LOCALITE` TODO: Model Documentation for Enumeration Literal SCIENTIFIC_CRUISE_LOCALITE value 304
`SCIENTIFIC_CRUISE_PROGRAM` TODO: Model Documentation for Enumeration Literal SCIENTIFIC_CRUISE_PROGRAM value 301
`SCIENTIFIC_CRUISE_RADIALE` TODO: Model Documentation for Enumeration Literal SCIENTIFIC_CRUISE_RADIALE value 305
`SCIENTIFIC_CRUISE_STRATA` TODO: Model Documentation for Enumeration Literal SCIENTIFIC_CRUISE_STRATA value 302
`SCIENTIFIC_CRUISE_SUB_STRATA` TODO: Model Documentation for Enumeration Literal SCIENTIFIC_CRUISE_SUB_STRATA value 303
`SOUS_RECTANGLE_STATISTIQUE` TODO: Model Documentation for Enumeration Literal SOUS_RECTANGLE_STATISTIQUE value 114

Field Summary
- Fields inherited from interface AdagioEnumerationDef
  CONFIG_OPTION_PREFIX

Method Summary

Methods
Modifier and Type	Method and Description
`static LocationLevelId`	`fromString(String name)` Retrieves an instance of LocationLevelId from `its name`.
`static LocationLevelId`	`fromValue(Integer value)` Returns an instance of LocationLevelId from Integer `value`.
`String`	`getDescription()`
`String`	`getKey()`
`Class<?>`	`getType()`
`Integer`	`getValue()` Gets the underlying value of this type safe enumeration.
`String`	`getValueAsString()`
`static List<Integer>`	`literals()` Returns an unmodifiable list containing the literals that are known by this enumeration.
`static List<String>`	`names()` Returns an unmodifiable list containing the names of the literals that are known by this enumeration.
`void`	`setValue(Integer newValue)`
`Integer`	`value()` Returns an enumeration literal Integer `value`.
`static LocationLevelId`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static LocationLevelId[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - PAYS_ISO3
```
public static final LocationLevelId PAYS_ISO3
```
    TODO: Model Documentation for Enumeration Literal PAYS_ISO3 value 21
  - PORT
```
public static final LocationLevelId PORT
```
    TODO: Model Documentation for Enumeration Literal PORT value 6
  - QUARTIER
```
public static final LocationLevelId QUARTIER
```
    TODO: Model Documentation for Enumeration Literal QUARTIER value 13
  - CRIEE
```
public static final LocationLevelId CRIEE
```
    TODO: Model Documentation for Enumeration Literal CRIEE value 7
  - RECTANGLE_STATISTIQUE
```
public static final LocationLevelId RECTANGLE_STATISTIQUE
```
    TODO: Model Documentation for Enumeration Literal RECTANGLE_STATISTIQUE value 113
  - RECTANGLE_CGPM_GFCM
```
public static final LocationLevelId RECTANGLE_CGPM_GFCM
```
    TODO: Model Documentation for Enumeration Literal RECTANGLE_CGPM_GFCM value 145
  - REGION
```
public static final LocationLevelId REGION
```
    TODO: Model Documentation for Enumeration Literal REGION value 31
  - DEPARTEMENT
```
public static final LocationLevelId DEPARTEMENT
```
    TODO: Model Documentation for Enumeration Literal DEPARTEMENT value 32
  - SOUS_RECTANGLE_STATISTIQUE
```
public static final LocationLevelId SOUS_RECTANGLE_STATISTIQUE
```
    TODO: Model Documentation for Enumeration Literal SOUS_RECTANGLE_STATISTIQUE value 114
  - FAO_ZONE
```
public static final LocationLevelId FAO_ZONE
```
    TODO: Model Documentation for Enumeration Literal FAO_ZONE value 101
  - SCIENTIFIC_CRUISE_PROGRAM
```
public static final LocationLevelId SCIENTIFIC_CRUISE_PROGRAM
```
    TODO: Model Documentation for Enumeration Literal SCIENTIFIC_CRUISE_PROGRAM value 301
  - SCIENTIFIC_CRUISE_STRATA
```
public static final LocationLevelId SCIENTIFIC_CRUISE_STRATA
```
    TODO: Model Documentation for Enumeration Literal SCIENTIFIC_CRUISE_STRATA value 302
  - SCIENTIFIC_CRUISE_SUB_STRATA
```
public static final LocationLevelId SCIENTIFIC_CRUISE_SUB_STRATA
```
    TODO: Model Documentation for Enumeration Literal SCIENTIFIC_CRUISE_SUB_STRATA value 303
  - SCIENTIFIC_CRUISE_LOCALITE
```
public static final LocationLevelId SCIENTIFIC_CRUISE_LOCALITE
```
    TODO: Model Documentation for Enumeration Literal SCIENTIFIC_CRUISE_LOCALITE value 304
  - SCIENTIFIC_CRUISE_RADIALE
```
public static final LocationLevelId SCIENTIFIC_CRUISE_RADIALE
```
    TODO: Model Documentation for Enumeration Literal SCIENTIFIC_CRUISE_RADIALE value 305
- Method Detail
  - values
```
public static LocationLevelId[] 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 (LocationLevelId c : LocationLevelId.values())
    System.out.println(c);
```
    Returns:
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static LocationLevelId 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
  - setValue
```
public void setValue(Integer newValue)
```
    Specified by:
    
    setValue in interface AdagioEnumerationDef<Integer>
  - getValueAsString
```
public String getValueAsString()
```
    Specified by:
    
    getValueAsString in interface AdagioEnumerationDef<Integer>
  - fromString
```
public static LocationLevelId fromString(String name)
```
    Retrieves an instance of LocationLevelId from its name.
    
    Parameters:
    name - the name to create the LocationLevelId from.
    
    Returns:
    The enumeration literal named after the 'name' argument
  - value
```
public Integer value()
```
    Returns an enumeration literal Integer value. Required by JAXB2 enumeration implementation
    
    Returns:
    Integer with corresponding value
  - fromValue
```
public static LocationLevelId fromValue(Integer value)
```
    Returns an instance of LocationLevelId from Integer value. Required by JAXB2 enumeration implementation
    
    Parameters:
    value - the value to create the LocationLevelId from.
    
    Returns:
    static Enumeration with corresponding value
  - getValue
```
public Integer getValue()
```
    Gets the underlying value of this type safe enumeration. This method is necessary to comply with DaoBase implementation.
    
    Specified by:
    
    getValue in interface AdagioEnumerationDef<Integer>
    
    Returns:
    The name of this literal.
  - getDescription
```
public String getDescription()
```
    Specified by:
    
    getDescription in interface AdagioEnumerationDef<Integer>
  - getKey
```
public String getKey()
```
    Specified by:
    
    getKey in interface AdagioEnumerationDef<Integer>
  - getType
```
public Class<?> getType()
```
    Specified by:
    
    getType in interface AdagioEnumerationDef<Integer>
  - literals
```
public static List<Integer> literals()
```
    Returns an unmodifiable list containing the literals that are known by this enumeration.
    
    Returns:
    A List containing the actual literals defined by this enumeration, this list can not be modified.
  - names
```
public static List<String> names()
```
    Returns an unmodifiable list containing the names of the literals that are known by this enumeration.
    
    Returns:
    A List containing the actual names of the literals defined by this enumeration, this list can not be modified.

Enum LocationLevelId

Enum Constant Summary

Field Summary

Fields inherited from interface AdagioEnumerationDef

Method Summary

Methods inherited from class Enum

Methods inherited from class Object

Enum Constant Detail

PAYS_ISO3

PORT

QUARTIER

CRIEE

RECTANGLE_STATISTIQUE

RECTANGLE_CGPM_GFCM

REGION

DEPARTEMENT

SOUS_RECTANGLE_STATISTIQUE

FAO_ZONE

SCIENTIFIC_CRUISE_PROGRAM

SCIENTIFIC_CRUISE_STRATA

SCIENTIFIC_CRUISE_SUB_STRATA

SCIENTIFIC_CRUISE_LOCALITE

SCIENTIFIC_CRUISE_RADIALE

Method Detail

values

valueOf

setValue

getValueAsString

fromString

value

fromValue

getValue

getDescription

getKey

getType

literals

names