BrAPISortBy (brapi-java-model 2.1.0 API)

java.lang.Object
- java.lang.Enum<BrAPISortBy>
- - org.brapi.v2.model.BrAPISortBy

All Implemented Interfaces:: Serializable, Comparable<BrAPISortBy>, BrAPIEnum

public enum BrAPISortBy
extends Enum<BrAPISortBy>
implements BrAPIEnum

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ENDDATE`
`GERMPLASMDBID`
`LOCATIONDBID`
`OBSERVATIONVARIABLEDBID`
`PROGRAMDBID`
`PROGRAMNAME`
`SEASONDBID`
`STARTDATE`
`STUDYDBID`
`STUDYLOCATION`
`STUDYNAME`
`STUDYTYPE`
`TRIALDBID`
`TRIALNAME`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static BrAPISortBy`	`fromValue(String text)`
`String`	`getBrapiValue()`
`String`	`toString()`
`static BrAPISortBy`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static BrAPISortBy[]`	`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, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - STUDYDBID
```
public static final BrAPISortBy STUDYDBID
```
  - STARTDATE
```
public static final BrAPISortBy STARTDATE
```
  - ENDDATE
```
public static final BrAPISortBy ENDDATE
```
  - TRIALDBID
```
public static final BrAPISortBy TRIALDBID
```
  - TRIALNAME
```
public static final BrAPISortBy TRIALNAME
```
  - PROGRAMDBID
```
public static final BrAPISortBy PROGRAMDBID
```
  - LOCATIONDBID
```
public static final BrAPISortBy LOCATIONDBID
```
  - SEASONDBID
```
public static final BrAPISortBy SEASONDBID
```
  - STUDYTYPE
```
public static final BrAPISortBy STUDYTYPE
```
  - STUDYNAME
```
public static final BrAPISortBy STUDYNAME
```
  - STUDYLOCATION
```
public static final BrAPISortBy STUDYLOCATION
```
  - PROGRAMNAME
```
public static final BrAPISortBy PROGRAMNAME
```
  - GERMPLASMDBID
```
public static final BrAPISortBy GERMPLASMDBID
```
  - OBSERVATIONVARIABLEDBID
```
public static final BrAPISortBy OBSERVATIONVARIABLEDBID
```
- Method Detail
  - values
```
public static BrAPISortBy[] 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 (BrAPISortBy c : BrAPISortBy.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static BrAPISortBy 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
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Enum<BrAPISortBy>
  - fromValue
```
public static BrAPISortBy fromValue(String text)
```
  - getBrapiValue
```
public String getBrapiValue()
```
    Specified by:
    
    getBrapiValue in interface BrAPIEnum

Enum BrAPISortBy

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

STUDYDBID

STARTDATE

ENDDATE

TRIALDBID

TRIALNAME

PROGRAMDBID

LOCATIONDBID

SEASONDBID

STUDYTYPE

STUDYNAME

STUDYLOCATION

PROGRAMNAME

GERMPLASMDBID

OBSERVATIONVARIABLEDBID

Method Detail

values

valueOf

toString

fromValue

getBrapiValue