Package com.storedobject.core

Interface Financial

All Known Implementing Classes:

CustomerInvoice, Invoice, JournalVoucher, SupplierInvoice

public interface Financial

The Financial interface represents a financial entity that can post ledger transactions. It provides methods to check if the ledger is already posted and to post a ledger transaction. It also provides a default method to post a ledger transaction using a TransactionManager.

Author:

Syam

Method Summary

Modifier and Type	Method	Description
default boolean	canReverseLedger()	Determines whether the ledger can be reversed.
static int	getBalanceType(Account account)	Retrieves the balance type of the given account.
static String	getBalanceTypeValue(Account account)	Retrieves the balance type value associated with the given account.
static int	getCategory(Account account)	Calculates and retrieves the category of the provided account based on its account status.
static String	getCategoryValue(Account account)	Retrieves the category value of the given account.
default JournalVoucher	getReversalJournalVoucher(String reversalReason, boolean appendToNarration)	Retrieves a reversal journal voucher based on the provided reversal reason and whether to append the reason to the narration.
static int	getTransactionType(Account account)	Determines the transaction type based on the account's status.
static String	getTransactionTypeValue(Account account)	Retrieves the transaction type value for a given account.
static boolean	hasLimitCheck(Account account)	Checks whether the given account has a limit check flag enabled.
static boolean	hasStrictBalanceControl(Account account)	Determines if the given account has strict balance control enabled.
static boolean	isActive(SystemEntity systemEntity)	Is a financial system active for this entity?
static boolean	isActive(TransactionManager tm)	Is a financial system active for this transaction manager?
static boolean	isAsset(Account account)	Determines whether the provided account is classified as an asset.
static boolean	isDeepFrozen(Account account)	Determines whether the provided account is deeply frozen.
static boolean	isExpense(Account account)	Determines whether the given account qualifies as an expense.
boolean	isLedgerPosted()	Checks if the ledger is already posted.
default boolean	isLedgerReversed()	Checks whether the ledger is reversed.
static boolean	isLiability(Account account)	Determines if the given account qualifies as a liability based on its category and balance type.
static boolean	isRevenue(Account account)	Determines if the provided account qualifies as a revenue account.
static boolean	isSpecial(Account account)	Determines if the given account is a special type of account.
default List<JournalVoucher>	listJournalVouchers()	Retrieves a list of journal vouchers associated with the current financial entity.
void	postLedger(TransactionManager transactionManager)	Posts ledger transactions using the provided TransactionManager.
default void	reverseLedger(TransactionManager transactionManager, String reversalReason, boolean appendToNarration)	Reverses the ledger transactions using the provided transaction manager.
default void	reverseLedger(Transaction transaction, String reversalReason, boolean appendToNarration)	Reverses a ledger by creating and saving a reversal journal voucher for the provided transaction.

Method Details

isLedgerPosted

boolean isLedgerPosted()

Checks if the ledger is already posted.

Returns:

true if the ledger is already posted, false otherwise.

isLedgerReversed

default boolean isLedgerReversed()

Checks whether the ledger is reversed.

Returns:

true if the ledger is reversed, false otherwise.

postLedger

void postLedger(TransactionManager transactionManager)
         throws Exception

Posts ledger transactions using the provided TransactionManager.

Parameters:

transactionManager - the TransactionManager used to post the ledger transaction

Throws:

Exception - if the ledger is already posted

canReverseLedger

default boolean canReverseLedger()

Determines whether the ledger can be reversed. This method provides a default implementation that specifies the ledger cannot be reversed and always returns false. Override this method to customize the reversal behavior based on specific conditions.

Returns:

true if the ledger can be reversed; otherwise false.

reverseLedger

default void reverseLedger(TransactionManager transactionManager,
 String reversalReason,
 boolean appendToNarration)
                    throws Exception

Reverses the ledger transactions using the provided transaction manager. This method delegates the reversal process to another method that works on a per-transaction basis.

Parameters:

transactionManager - the transaction manager used to handle the reversal process

reversalReason - a string specifying the reason for the reversal

appendToNarration - a boolean indicating whether to append the reversal reason to the narration

Throws:

Exception - if an error occurs during the reversal process

reverseLedger

default void reverseLedger(Transaction transaction,
 String reversalReason,
 boolean appendToNarration)
                    throws Exception

Reverses a ledger by creating and saving a reversal journal voucher for the provided transaction.

Parameters:

transaction - the transaction to be reversed

reversalReason - the reason for reversing the transaction

appendToNarration - whether to append the reversal reason to the narration

Throws:

Exception - if an error occurs during the reversal process

getReversalJournalVoucher

default JournalVoucher getReversalJournalVoucher(String reversalReason,
 boolean appendToNarration)
                                          throws Exception

Retrieves a reversal journal voucher based on the provided reversal reason and whether to append the reason to the narration.

This method performs the following checks: - Verifies that the ledger has been posted. - Confirms that the ledger supports reversal operations. - Ensures there is at least one journal voucher to reverse.

If any of these conditions are not met, an exception is thrown.

Parameters:

reversalReason - the reason for reversing the journal voucher

appendToNarration - a flag indicating whether the reversal reason should be appended to the voucher narration

Returns:

the reversal journal voucher for the first available journal voucher

Throws:

Exception - if: - the ledger is not posted, - the ledger does not support reversal, or - there are no journal vouchers to reverse

listJournalVouchers

default List<JournalVoucher> listJournalVouchers()

Retrieves a list of journal vouchers associated with the current financial entity. If the current object is an instance of StoredObject, it queries the relevant journal vouchers based on the owner's identifier. Otherwise, it returns an empty list.

Returns:

a list of JournalVoucher instances tied to the financial entity, or an empty list if the object is not a StoredObject.

getCategory

static int getCategory(Account account)

Calculates and retrieves the category of the provided account based on its account status.

Parameters:

account - the account whose category is to be determined

Returns:

an integer representing the category, determined by shifting the account's status bits and applying a mask

getCategoryValue

static String getCategoryValue(Account account)

Retrieves the category value of the given account.

Parameters:

account - the account object from which the category value is to be obtained

Returns:

the category value associated with the specified account

getBalanceType

static int getBalanceType(Account account)

Retrieves the balance type of the given account.

Parameters:

account - the account for which the balance type is to be determined

Returns:

an integer representing the balance type, where the type is derived from the account's status

getBalanceTypeValue

static String getBalanceTypeValue(Account account)

Retrieves the balance type value associated with the given account.

Parameters:

account - The account for which the balance type value is to be retrieved.

Returns:

The balance type value as a string.

getTransactionType

static int getTransactionType(Account account)

Determines the transaction type based on the account's status.

Parameters:

account - the account object whose status is used to determine the transaction type

Returns:

an integer representing the calculated transaction type

getTransactionTypeValue

static String getTransactionTypeValue(Account account)

Retrieves the transaction type value for a given account.

Parameters:

account - The account for which the transaction type value is to be determined.

Returns:

The corresponding transaction type value as a string.

hasStrictBalanceControl

static boolean hasStrictBalanceControl(Account account)

Determines if the given account has strict balance control enabled.

Parameters:

account - the account to evaluate

Returns:

true if the account has strict balance control enabled, false otherwise

hasLimitCheck

static boolean hasLimitCheck(Account account)

Checks whether the given account has a limit check flag enabled. This method examines the account's status by performing a bitwise operation to determine if the specific limit check flag is set.

Parameters:

account - the account to be checked

Returns:

true if the account has the limit check flag enabled, false otherwise

isDeepFrozen

static boolean isDeepFrozen(Account account)

Determines whether the provided account is deeply frozen.

Parameters:

account - The account to check for the deep-frozen status.

Returns:

true if the account is deeply frozen, false otherwise.

isSpecial

static boolean isSpecial(Account account)

Determines if the given account is a special type of account.

Parameters:

account - the account to check; can be an instance of AccountTitle, BranchAccount, or OffsetAccount

Returns:

true if the account is an instance of AccountTitle, BranchAccount, or OffsetAccount; false otherwise

isAsset

static boolean isAsset(Account account)

Determines whether the provided account is classified as an asset.

Parameters:

account - the account to be evaluated

Returns:

true if the account is categorized as an asset, otherwise false

isLiability

static boolean isLiability(Account account)

Determines if the given account qualifies as a liability based on its category and balance type.

Parameters:

account - the account to be evaluated

Returns:

true if the account is classified as a liability, false otherwise

isExpense

static boolean isExpense(Account account)

Determines whether the given account qualifies as an expense.

Parameters:

account - the account to be checked.

Returns:

true if the account's category is 1 and its balance type is 0, false otherwise.

isRevenue

static boolean isRevenue(Account account)

Determines if the provided account qualifies as a revenue account.

Parameters:

account - The account object to be evaluated.

Returns:

true if the account's category is 0 and the balance type is 1, otherwise false.

isActive

static boolean isActive(SystemEntity systemEntity)

Is a financial system active for this entity?

Returns:

True/false.

isActive

static boolean isActive(TransactionManager tm)

Is a financial system active for this transaction manager?

Returns:

True/false.