Payment (josef 3.2.5 API)

java.lang.Object
- java.lang.Enum<Payment>
- - org.josef.finance.Payment

All Implemented Interfaces:

Serializable, Comparable<Payment>
```
@Status(stage=DEVELOPMENT,
        unitTests=ABSENT)
public enum Payment
extends Enum<Payment>
```
Enumeration of payments.

Version:

1.0 $Revision: 6488 $

Author:

Kees Schotanus

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ANNUALLY` Yearly payment at the start of the year.
`ANNUALLY_AT_END` Yearly payment at the end of the year.
`BI_MONTHLY` Bi-monthly payment (6 times per year) at the start of the two months.
`BI_MONTHLY_AT_END` Bi-monthly payment (6 times per year) at the end of the two months.
`DAILY` Daily payment.
`FOUR_MONTHLY` Four-monthly payment (3 times per year) at the start of the trimester.
`FOUR_MONTHLY_AT_END` Four-monthly payment (3 times per year) at the end of the trimester.
`MONTHLY` Monthly payment at the start of the month.
`MONTHLY_AT_END` Monthly payment at the end of the month.
`QUARTERLY` Quarterly payment (4 times per year) at the start of the quarter.
`QUARTERLY_AT_END` Quarterly payment (4 times per year) at the end of the quarter.
`SEMI_ANNUALLY_AT_END` Semi-annually (2 times per year) payment at the end of the half year.
`SEMI_ANUALLY` Semi-annually (2 times per year) payment at the start of the half year.
`WEEKLY` Weekly payment at the start of the week.
`WEEKLY_AT_END` Weekly payment at the end of the week.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PaymentMoment`	`getMoment()` Gets moment at which the payments take place.
`int`	`getPaymentsPerYear()` Gets the number of payments per year.
`static Payment`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static Payment[]`	`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
  - DAILY
```
public static final Payment DAILY
```
    Daily payment.
    Assumes a year will have 365 payments.
  - WEEKLY
```
public static final Payment WEEKLY
```
    Weekly payment at the start of the week.
    Assumes a year will have 52 payments.
  - WEEKLY_AT_END
```
public static final Payment WEEKLY_AT_END
```
    Weekly payment at the end of the week.
    Assumes a year will have 52 payments.
  - MONTHLY
```
public static final Payment MONTHLY
```
    Monthly payment at the start of the month.
  - MONTHLY_AT_END
```
public static final Payment MONTHLY_AT_END
```
    Monthly payment at the end of the month.
  - BI_MONTHLY
```
public static final Payment BI_MONTHLY
```
    Bi-monthly payment (6 times per year) at the start of the two months.
  - BI_MONTHLY_AT_END
```
public static final Payment BI_MONTHLY_AT_END
```
    Bi-monthly payment (6 times per year) at the end of the two months.
  - QUARTERLY
```
public static final Payment QUARTERLY
```
    Quarterly payment (4 times per year) at the start of the quarter.
  - QUARTERLY_AT_END
```
public static final Payment QUARTERLY_AT_END
```
    Quarterly payment (4 times per year) at the end of the quarter.
  - FOUR_MONTHLY
```
public static final Payment FOUR_MONTHLY
```
    Four-monthly payment (3 times per year) at the start of the trimester.
  - FOUR_MONTHLY_AT_END
```
public static final Payment FOUR_MONTHLY_AT_END
```
    Four-monthly payment (3 times per year) at the end of the trimester.
  - SEMI_ANUALLY
```
public static final Payment SEMI_ANUALLY
```
    Semi-annually (2 times per year) payment at the start of the half year.
  - SEMI_ANNUALLY_AT_END
```
public static final Payment SEMI_ANNUALLY_AT_END
```
    Semi-annually (2 times per year) payment at the end of the half year.
  - ANNUALLY
```
public static final Payment ANNUALLY
```
    Yearly payment at the start of the year.
  - ANNUALLY_AT_END
```
public static final Payment ANNUALLY_AT_END
```
    Yearly payment at the end of the year.
- Method Detail
  - values
```
public static Payment[] 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 (Payment c : Payment.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Payment 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
  - getPaymentsPerYear
```
public int getPaymentsPerYear()
```
    Gets the number of payments per year.
    
    Returns:
    
    The number of payments per year.
  - getMoment
```
public PaymentMoment getMoment()
```
    Gets moment at which the payments take place.
    
    Returns:
    
    The moment at which the payments take place.

Enum Payment

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

DAILY

WEEKLY

WEEKLY_AT_END

MONTHLY

MONTHLY_AT_END

BI_MONTHLY

BI_MONTHLY_AT_END

QUARTERLY

QUARTERLY_AT_END

FOUR_MONTHLY

FOUR_MONTHLY_AT_END

SEMI_ANUALLY

SEMI_ANNUALLY_AT_END

ANNUALLY

ANNUALLY_AT_END

Method Detail

values

valueOf

getPaymentsPerYear

getMoment