Package com.storedobject.core

Interface Ledger

All Superinterfaces:

AutoCloseable, Iterable<LedgerEntry>, Iterator<LedgerEntry>

public interface Ledger
extends Iterator<LedgerEntry>, Iterable<LedgerEntry>, AutoCloseable

Representation of a set of entries in the "Transaction Ledger". Please note that this class implements both Iterator and Iterable interfaces and thus, it is possible to iterate through the entries (instances of LedgerEntry) using constructs such as "for" loops.

Note: Use Account.getLedger(DatePeriod) to create an instance of the Ledger.

Author:

Syam

Method Summary

Modifier and Type	Method	Description
Account	getAccount()	The account of this ledger.
Money	getLocalCurrencyOpeningBalance()	Local currency opening balance.
Money	getOpeningBalance()	Foreign currency opening balance.
DatePeriod	getPeriod()	The date-period selected.
default Iterator<LedgerEntry>	iterator()	Iterator for LedgerEntrys.
default void	remove()	This method exists for API conformance.

Methods inherited from interface java.lang.AutoCloseable

close

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface java.util.Iterator

forEachRemaining, hasNext, next

Method Details

getOpeningBalance

Money getOpeningBalance()

Foreign currency opening balance.

Returns:

Foreign currency balance.

getLocalCurrencyOpeningBalance

Money getLocalCurrencyOpeningBalance()

Local currency opening balance.

Returns:

Local currency balance.

getAccount

Account getAccount()

The account of this ledger.

Returns:

Account.

getPeriod

DatePeriod getPeriod()

The date-period selected.

Returns:

Date-period selected.

iterator

@Nonnull
default Iterator<LedgerEntry> iterator()

Iterator for LedgerEntrys.

Specified by:

iterator in interface Iterable<LedgerEntry>

Returns:

Ledger entry iterator.

remove

default void remove()

This method exists for API conformance. However, this operation is not supported.

Specified by:

remove in interface Iterator<LedgerEntry>