org.killbill.billing.overdue.api

Interface OverdueState

public interface OverdueState

Method Summary

Modifier and Type	Method and Description
Duration	getAutoReevaluationInterval()
java.lang.String	getExternalMessage()
java.lang.String	getName()
OverdueCancellationPolicy	getOverdueCancellationPolicy()
OverdueCondition	getOverdueCondition()
boolean	isBlockChanges()
boolean	isClearState()
boolean	isDisableEntitlementAndChangesBlocked() (Bad name, keep it at API level to be consistent with xml config)

Method Detail

getOverdueCondition

OverdueCondition getOverdueCondition()

Returns:

the condition to evaluate on to decide on the state

getName

java.lang.String getName()

Returns:

the name of the overdue state

getExternalMessage

java.lang.String getExternalMessage()

Returns:

the external message associated to the state (user facing)

isBlockChanges

boolean isBlockChanges()

Returns:

whether the system allows to make plan change on existing subscriptions

isDisableEntitlementAndChangesBlocked

boolean isDisableEntitlementAndChangesBlocked()

(Bad name, keep it at API level to be consistent with xml config)

Returns:

whether the subscriptions are being paused, which means service (entitlement) will be disabled and billing will also be disabled.

getOverdueCancellationPolicy

OverdueCancellationPolicy getOverdueCancellationPolicy()

Returns:

the cancellation policy If set to NONE, no cancellation will be performed when reaching that state

isClearState

boolean isClearState()

Returns:

whether that state is defined as being the 'clear' state.

getAutoReevaluationInterval

Duration getAutoReevaluationInterval()
                              throws OverdueApiException

Returns:

the period of time for the system to reevaluate the state after it entered in the given state

Throws:

OverdueApiException