gov.nih.nci.caarray.domain.search
Enum PersonSortCriterion

java.lang.Object
  extended by java.lang.Enum<PersonSortCriterion>
      extended by gov.nih.nci.caarray.domain.search.PersonSortCriterion
All Implemented Interfaces:
com.fiveamsolutions.nci.commons.data.search.SortCriterion<Person>, java.io.Serializable, java.lang.Comparable<PersonSortCriterion>

public enum PersonSortCriterion
extends java.lang.Enum<PersonSortCriterion>
implements com.fiveamsolutions.nci.commons.data.search.SortCriterion<Person>

Enum of possible sort criterions for Person objects.

Author:
Jevon Gill

Enum Constant Summary
EMAIL
          Person email.
FIRST_NAME
          Person first name.
LAST_NAME
          Person last name.
PHONE
          Person phone.
 
Method Summary
 java.lang.String getLeftJoinField()
          
 java.lang.String getOrderField()
          
static PersonSortCriterion valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static PersonSortCriterion[] 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
 

Enum Constant Detail

FIRST_NAME

public static final PersonSortCriterion FIRST_NAME
Person first name.


LAST_NAME

public static final PersonSortCriterion LAST_NAME
Person last name.


EMAIL

public static final PersonSortCriterion EMAIL
Person email.


PHONE

public static final PersonSortCriterion PHONE
Person phone.

Method Detail

values

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

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

valueOf

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

getOrderField

public java.lang.String getOrderField()

Specified by:
getOrderField in interface com.fiveamsolutions.nci.commons.data.search.SortCriterion<Person>

getLeftJoinField

public java.lang.String getLeftJoinField()

Specified by:
getLeftJoinField in interface com.fiveamsolutions.nci.commons.data.search.SortCriterion<Person>