Package org.cyclos.model.banking.transactions

Enum InstallmentStatus

java.lang.Object

java.lang.Enum<InstallmentStatus>

org.cyclos.model.banking.transactions.InstallmentStatus

All Implemented Interfaces:

Serializable, Comparable<InstallmentStatus>, HasMessageKey

public enum InstallmentStatus
extends Enum<InstallmentStatus>
implements HasMessageKey

The possible statuses for a installment

Enum Constant Summary

Enum Constants

Enum Constant	Description
BLOCKED	The installment is blocked to prevent automatic processing
CANCELED	The payer has canceled the scheduled payment
FAILED	The installment couldn't be processed (i.e: not enough credits)
PROCESSED	The installment has been successfully processed
SCHEDULED	The installment is scheduled for future processing
SETTLED	The receiver has marked the installment as settled

Method Summary

Modifier and Type	Method	Description
MessageKey	getMessageKey()
boolean	isTerminal()	Returns whether this status is a terminal status - that means - cannot be changed.
static InstallmentStatus	valueOf(String name)	Returns the enum constant of this type with the specified name.
static InstallmentStatus[]	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

SCHEDULED

public static final InstallmentStatus SCHEDULED

The installment is scheduled for future processing

PROCESSED

public static final InstallmentStatus PROCESSED

The installment has been successfully processed

CANCELED

public static final InstallmentStatus CANCELED

The payer has canceled the scheduled payment

SETTLED

public static final InstallmentStatus SETTLED

The receiver has marked the installment as settled

FAILED

public static final InstallmentStatus FAILED

The installment couldn't be processed (i.e: not enough credits)

BLOCKED

public static final InstallmentStatus BLOCKED

The installment is blocked to prevent automatic processing

Method Detail

values

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

Returns:

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

valueOf

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

isTerminal

public boolean isTerminal()

Returns whether this status is a terminal status - that means - cannot be changed. The terminal statuses are PROCESSED, CANCELED and SETTLED