org.cyclos.model.banking.transactions

Enum ScheduledPaymentInstallmentStatus

java.lang.Object

java.lang.Enum<ScheduledPaymentInstallmentStatus>

org.cyclos.model.banking.transactions.ScheduledPaymentInstallmentStatus

All Implemented Interfaces:

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

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

The possible statuses for a scheduled payment installment

Author:

luis

Enum Constant Summary

Enum Constants

Enum Constant and 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 and Description
boolean	isTerminal() Returns whether this status is a terminal status - that means - cannot be changed.
static ScheduledPaymentInstallmentStatus	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ScheduledPaymentInstallmentStatus[]	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 ScheduledPaymentInstallmentStatus SCHEDULED

The installment is scheduled for future processing

PROCESSED

public static final ScheduledPaymentInstallmentStatus PROCESSED

The installment has been successfully processed

CANCELED

public static final ScheduledPaymentInstallmentStatus CANCELED

The payer has canceled the scheduled payment

SETTLED

public static final ScheduledPaymentInstallmentStatus SETTLED

The receiver has marked the installment as settled

FAILED

public static final ScheduledPaymentInstallmentStatus FAILED

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

BLOCKED

public static final ScheduledPaymentInstallmentStatus BLOCKED

The installment is blocked to prevent automatic processing

Method Detail

values

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

Returns:

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

valueOf

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

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