Package org.cyclos.model.banking.transactions

Enum TransactionNature

java.lang.Object

java.lang.Enum<TransactionNature>

org.cyclos.model.banking.transactions.TransactionNature

All Implemented Interfaces:

Serializable, Comparable<TransactionNature>

public enum TransactionNature
extends Enum<TransactionNature>

Contains the possible natures for a transaction

Enum Constant Summary

Enum Constants

Enum Constant	Description
EXTERNAL_PAYMENT	A payment to an external user
IMPORT	An imported transaction
PAYMENT	A direct payment
PAYMENT_REQUEST	A request for another user to accept a payment
RECURRING_PAYMENT	A payment which is processed recurrently
SCHEDULED_PAYMENT	A scheduled payment generated manually
TICKET	A payment to a user to be confirmed by the payer user.

Method Summary

Modifier and Type	Method	Description
static EnumSet<TransactionNature>	basePayment()	Returns the natures that represent a base payment
boolean	hasInstallments()	Returns whether transactions of this nature have installments
boolean	hasStatus()	Returns whether transactions of this nature have a status
boolean	isBasePayment()	Returns whether the nature represent "payments", be them direct, scheduled or recurring.
static TransactionNature	valueOf(String name)	Returns the enum constant of this type with the specified name.
static TransactionNature[]	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

PAYMENT

public static final TransactionNature PAYMENT

A direct payment

SCHEDULED_PAYMENT

public static final TransactionNature SCHEDULED_PAYMENT

A scheduled payment generated manually

RECURRING_PAYMENT

public static final TransactionNature RECURRING_PAYMENT

A payment which is processed recurrently

IMPORT

public static final TransactionNature IMPORT

An imported transaction

PAYMENT_REQUEST

public static final TransactionNature PAYMENT_REQUEST

A request for another user to accept a payment

EXTERNAL_PAYMENT

public static final TransactionNature EXTERNAL_PAYMENT

A payment to an external user

TICKET

public static final TransactionNature TICKET

A payment to a user to be confirmed by the payer user.

Method Detail

values

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

Returns:

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

valueOf

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

basePayment

public static EnumSet<TransactionNature> basePayment()

Returns the natures that represent a base payment

hasInstallments

public boolean hasInstallments()

Returns whether transactions of this nature have installments

hasStatus

public boolean hasStatus()

Returns whether transactions of this nature have a status

isBasePayment

public boolean isBasePayment()

Returns whether the nature represent "payments", be them direct, scheduled or recurring.