Package org.cyclos.model.banking.transactions

Enum ScheduledPaymentStatus

java.lang.Object

java.lang.Enum<ScheduledPaymentStatus>

org.cyclos.model.banking.transactions.ScheduledPaymentStatus

All Implemented Interfaces:

Serializable, Comparable<ScheduledPaymentStatus>, TransactionStatus, HasMessageKey

public enum ScheduledPaymentStatus
extends Enum<ScheduledPaymentStatus>
implements TransactionStatus

The possible statuses for a scheduled payment

Enum Constant Summary

Enum Constants

Enum Constant	Description
BLOCKED	The scheduled payment is blocked, preventing installments from being automatically processed
CANCELED	The scheduled payment was canceled while open by the payer
CLOSED	The scheduled payment has all installments as processed
OPEN	The scheduled payment is still open

Method Summary

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

OPEN

public static final ScheduledPaymentStatus OPEN

The scheduled payment is still open

CLOSED

public static final ScheduledPaymentStatus CLOSED

The scheduled payment has all installments as processed

BLOCKED

public static final ScheduledPaymentStatus BLOCKED

The scheduled payment is blocked, preventing installments from being automatically processed

CANCELED

public static final ScheduledPaymentStatus CANCELED

The scheduled payment was canceled while open by the payer

Method Detail

values

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

Returns:

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

valueOf

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

getMessageKey

public MessageKey getMessageKey()

Specified by:

getMessageKey in interface HasMessageKey