org.cyclos.model.banking.vouchers

Enum VoucherOrderBy

java.lang.Object

java.lang.Enum<VoucherOrderBy>

org.cyclos.model.banking.vouchers.VoucherOrderBy

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<VoucherOrderBy>

public enum VoucherOrderBy
extends java.lang.Enum<VoucherOrderBy>

The possible order by option for a voucher search

Author:

luis

Enum Constant Summary

Enum Constants

Enum Constant and Description
CREATION_DATE_ASC Order by creation date, ascending
CREATION_DATE_DESC Order by creation date, descending (default)
EXPIRATION_DATE_ASC Order by expiration date, ascending
EXPIRATION_DATE_DESC Order by expiration date, descending
REDEEM_DATE_ASC Order by redeem date, ascending, then expiration date, ascending
REDEEM_DATE_DESC Order by redeem date, descending, then expiration date, descending

Method Summary

Modifier and Type	Method and Description
static VoucherOrderBy	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static VoucherOrderBy[]	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

CREATION_DATE_DESC

public static final VoucherOrderBy CREATION_DATE_DESC

Order by creation date, descending (default)

CREATION_DATE_ASC

public static final VoucherOrderBy CREATION_DATE_ASC

Order by creation date, ascending

EXPIRATION_DATE_DESC

public static final VoucherOrderBy EXPIRATION_DATE_DESC

Order by expiration date, descending

EXPIRATION_DATE_ASC

public static final VoucherOrderBy EXPIRATION_DATE_ASC

Order by expiration date, ascending

REDEEM_DATE_DESC

public static final VoucherOrderBy REDEEM_DATE_DESC

Order by redeem date, descending, then expiration date, descending

REDEEM_DATE_ASC

public static final VoucherOrderBy REDEEM_DATE_ASC

Order by redeem date, ascending, then expiration date, ascending

Method Detail

values

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

Returns:

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

valueOf

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