Package org.killbill.billing.catalog.api

Enum BillingActionPolicy

java.lang.Object

java.lang.Enum<BillingActionPolicy>

org.killbill.billing.catalog.api.BillingActionPolicy

All Implemented Interfaces:

Serializable, Comparable<BillingActionPolicy>

public enum BillingActionPolicy
extends Enum<BillingActionPolicy>

Specifies how Subscription cancellation or plan change should operate

Enum Constant Summary

Enum Constants

Enum Constant	Description
END_OF_TERM	The cancellation or Plan change effectiveDate will occur at the end of the current invoiced service period, and that will not trigger any proration and credit.
ILLEGAL
IMMEDIATE	The cancellation or Plan change effectiveDate will occur at the requestedDate
START_OF_TERM	The cancellation or Plan change effectiveDate will occur at the start of the current invoiced service period and that will trigger a full credit.

Method Summary

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

START_OF_TERM

public static final BillingActionPolicy START_OF_TERM

The cancellation or Plan change effectiveDate will occur at the start of the current invoiced service period and that will trigger a full credit.

END_OF_TERM

public static final BillingActionPolicy END_OF_TERM

The cancellation or Plan change effectiveDate will occur at the end of the current invoiced service period, and that will not trigger any proration and credit.

IMMEDIATE

public static final BillingActionPolicy IMMEDIATE

The cancellation or Plan change effectiveDate will occur at the requestedDate

ILLEGAL

public static final BillingActionPolicy ILLEGAL

Method Detail

values

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

Returns:

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

valueOf

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