Package org.salespointframework.accountancy

Interface Accountancy

@Service
public interface Accountancy

An application service to manage AccountancyEntrys and to create basic financial statistics.

Author:

Hannes Weisbach, Oliver Drotbohm, Martin Morgenstern

Method Summary

Modifier and Type	Method	Description
<T extends AccountancyEntry> T	add(T entry)	Adds a new AccountancyEntry to this Accountancy.
Streamable<AccountancyEntry>	find(Interval interval)	Returns all AccountancyEntrys that have a date within the given Interval.
<T extends AccountancyEntry> Streamable<T>	find(Interval interval, Class<T> type)	Returns all AccountancyEntrys of the given type for the given Interval.
Map<Interval,Streamable<AccountancyEntry>>	find(Interval interval, TemporalAmount duration)	Returns all AccountancyEntrys within the given interval, grouped by sub-intervals of the given duration.
<T extends AccountancyEntry> Map<Interval,Streamable<T>>	find(Interval interval, TemporalAmount duration, Class<T> type)	Returns all AccountancyEntrys of the given type within the given interval, grouped by sub-intervals of the given duration.
Streamable<AccountancyEntry>	findAll()	Returns all AccountancyEntrys previously added to the accountancy.
<T extends AccountancyEntry> Streamable<T>	findAll(Class<T> type)	Returns all AccountancyEntry instances of the given types, and the given types only.
Optional<AccountancyEntry>	get(AccountancyEntry.AccountancyEntryIdentifier identifier)	Returns the AccountancyEntry identified by the given AccountancyEntry.AccountancyEntryIdentifier, if it exists.
<T extends AccountancyEntry> Optional<T>	get(AccountancyEntry.AccountancyEntryIdentifier identifier, Class<T> type)	Returns the AccountancyEntry identified by the given AccountancyEntry.AccountancyEntryIdentifier of the given type, if it exists.
Map<Interval,javax.money.MonetaryAmount>	salesVolume(Interval interval, TemporalAmount duration)	Computes the sales volume, i.e., the sum of AccountancyEntry.getValue(), for all AccountancyEntrys within the given interval, grouped by sub-intervals of the given duration.

Method Details

add

<T extends AccountancyEntry> T add(T entry)

Adds a new AccountancyEntry to this Accountancy. The AccountancyEntry's date will be set to the value returned by BusinessTime.getTime() in case it is not set already.

Parameters:

entry - entry to be added to the accountancy, must not be null.

Returns:

the added AccountancyEntry.

findAll

Streamable<AccountancyEntry> findAll()

Returns all AccountancyEntrys previously added to the accountancy.

Returns:

a Streamable containing all entries, or an empty Streamable.

findAll

<T extends AccountancyEntry> Streamable<T> findAll(Class<T> type)

Returns all AccountancyEntry instances of the given types, and the given types only. This means the asking for intermediate types in an inheritance hierarchy is not sufficient. All leaf types of the hierarchy would have to be passed in.

Type Parameters:

T - the concrete subtype of AccountancyEntry.

Parameters:

type - must not be null.

Returns:

will never be null.

Since:

9.0

get

Optional<AccountancyEntry> get(AccountancyEntry.AccountancyEntryIdentifier identifier)

Returns the AccountancyEntry identified by the given AccountancyEntry.AccountancyEntryIdentifier, if it exists.

Parameters:

identifier - the AccountancyEntry.AccountancyEntryIdentifier of the entry to be returned, must not be null.

Returns:

an Optional with a matching AccountancyEntry, or an empty Optional if no match was found.

get

<T extends AccountancyEntry> Optional<T> get(AccountancyEntry.AccountancyEntryIdentifier identifier,
 Class<T> type)

Returns the AccountancyEntry identified by the given AccountancyEntry.AccountancyEntryIdentifier of the given type, if it exists.

Parameters:

identifier - the AccountancyEntry.AccountancyEntryIdentifier of the entry to be returned, must not be null.

type - the concrete AccountancyEntry type, must not be null.

Returns:

an Optional with a matching AccountancyEntry, or an empty Optional if no match was found.

Since:

9.0

find

Streamable<AccountancyEntry> find(Interval interval)

Returns all AccountancyEntrys that have a date within the given Interval.

Parameters:

interval - the interval within which we want to find AccountancyEntrys, must not be null.

Returns:

a Streamable containing all entries in the given interval, or an empty Streamable.

find

<T extends AccountancyEntry> Streamable<T> find(Interval interval,
 Class<T> type)

Returns all AccountancyEntrys of the given type for the given Interval.

Type Parameters:

T -

Parameters:

interval - must not be null.

type - must not be null.

Returns:

will never be null.

Since:

9.0

find

Map<Interval,Streamable<AccountancyEntry>> find(Interval interval,
 TemporalAmount duration)

Returns all AccountancyEntrys within the given interval, grouped by sub-intervals of the given duration. These sub-intervals are used as the keys of the returned Map. Note that the last sub-interval may be shorter than the given duration.

Parameters:

interval - the interval within which we want to find AccountancyEntrys, must not be null.

duration - the duration of the sub-intervals, must not be null.

Returns:

a Map containing a Streamable with zero or more AccountancyEntrys for each sub-interval.

find

<T extends AccountancyEntry>
Map<Interval,Streamable<T>> find(Interval interval,
 TemporalAmount duration,
 Class<T> type)

Returns all AccountancyEntrys of the given type within the given interval, grouped by sub-intervals of the given duration. These sub-intervals are used as the keys of the returned Map. Note that the last sub-interval may be shorter than the given duration.

Parameters:

interval - the interval within which we want to find AccountancyEntrys, must not be null.

duration - the duration of the sub-intervals, must not be null.

type -

Returns:

a Map containing a Streamable with zero or more AccountancyEntrys for each sub-interval.

Since:

9.0

salesVolume

Map<Interval,javax.money.MonetaryAmount> salesVolume(Interval interval,
 TemporalAmount duration)

Computes the sales volume, i.e., the sum of AccountancyEntry.getValue(), for all AccountancyEntrys within the given interval, grouped by sub-intervals of the given duration. If a sub-interval doesn't contain an AccountancyEntry, its sales volume is zero. Note that the last sub-interval may be shorter than the given duration.

Parameters:

interval - the interval within which we want to find AccountancyEntrys, must not be null.

duration - the duration of the sub-intervals that are used to group the summation, must not be null.

Returns:

a Map containing the summed up MonetaryAmount for each sub-interval.