net.bhardy.bizzo.billing

Interface BillingPolicy

public interface BillingPolicy

A billing policy helps you figure out billing cycles, i.e. when bills are due.

START HERE with a call to BillingPolicy.builder() to start creating a policy.

Method Summary

Modifier and Type	Method and Description
static PolicyBuilder	builder() To create a new policy, call BillingPolicy.builder().
CycleType	getCycleType() Get the rough billing cycle type for this policy, e.g.
boolean	isDueOn(LocalDate day) Given a date, determine if this billing policy is falling due on that date.
List<LocalDate>	upcomingDueDates(LocalDate day, int howMany) Figure out which dates are upcoming due dates according to this billing policy.

Method Detail

isDueOn

boolean isDueOn(LocalDate day)

Given a date, determine if this billing policy is falling due on that date.

This takes filters into consideration.

Parameters:

day - - the date to check

Returns:

true if the bill is due on that date, false otherwise.

upcomingDueDates

List<LocalDate> upcomingDueDates(LocalDate day,
                                 int howMany)

Figure out which dates are upcoming due dates according to this billing policy.

This takes filters into consideration, which leads to an interesting edge case: If a filter that causes a date under examination to be moved to an date earlier than the supplied date, it will not be returned. Which is what you'd want, since it's not actually "upcoming".

This is inclusive. A bill could fall due on the first day you're checking.

Parameters:

day - - the first date to check

howMany - - the total number of upcoming dates to check

Returns:

a list of howMany dates at or after firstDay, in chronological order.

getCycleType

CycleType getCycleType()

Get the rough billing cycle type for this policy, e.g. MONTHLY, WEEKLY etc.

Returns:

the kind of cycle.

builder

static PolicyBuilder builder()

To create a new policy, call BillingPolicy.builder(). This will enable you to fluently start building a policy.

e.g.:
BillingPolicy payDay = BillingPolicy.builder() .sameDayEveryMonth(15) .filter(not(daysOfWeek(SATURDAY, SUNDAY))) .build();

Returns:

the policy builder.