org.kuali.kfs.module.ld.service
Interface LaborInquiryOptionsService

All Known Implementing Classes:

LaborInquiryOptionsServiceImpl

public interface LaborInquiryOptionsService

The LaborInquiryOptionsService interface provides hooks for Pending Ledger and Consilidation options for balance inquiries.

Method Summary

org.kuali.rice.kns.web.ui.Field	getConsolidationField(Collection<org.kuali.rice.kns.web.ui.Row> rows) Examine a collection of Row instances for the consolidation field
String	getConsolidationFieldName() The expected name of the consolidation option field name
String	getConsolidationOption(Map fieldValues) Get the current state of the consolidation option
String	getSelectedPendingEntryOption(Map fieldValues) Get the Pending Entry Option selected
boolean	isConsolidationSelected(Map fieldValues) This method tests if the user selects to see the details or consolidated results
boolean	isConsolidationSelected(Map fieldValues, Collection<org.kuali.rice.kns.web.ui.Row> rows) This method tests if the user selects to see the details or consolidated results
void	updateCurrentFundsByPendingLedgerEntry(Collection<AccountStatusCurrentFunds> balanceCollection, Map fieldValues, String pendingEntryOption, boolean isConsolidated) update a given balance collection with the pending entry obtained from the given field values and pending entry option
void	updateLedgerBalanceByPendingLedgerEntry(Collection<LedgerBalance> balanceCollection, Map fieldValues, String pendingEntryOption, boolean isConsolidated) update a given balance collection with the pending entry obtained from the given field values and pending entry option
void	updateLedgerEntryByPendingLedgerEntry(Collection<LedgerEntry> entryCollection, Map fieldValues, String pendingEntryOption) update a given ledger entry collection with the pending entry obtained from the given field values and pending entry option

Method Detail

getConsolidationFieldName

String getConsolidationFieldName()

The expected name of the consolidation option field name

Returns:

String

getConsolidationField

org.kuali.rice.kns.web.ui.Field getConsolidationField(Collection<org.kuali.rice.kns.web.ui.Row> rows)

Examine a collection of Row instances for the consolidation field

Parameters:

rows -

Returns:

Field

getConsolidationOption

String getConsolidationOption(Map fieldValues)

Get the current state of the consolidation option

Returns:

String

isConsolidationSelected

boolean isConsolidationSelected(Map fieldValues,
                                Collection<org.kuali.rice.kns.web.ui.Row> rows)

This method tests if the user selects to see the details or consolidated results

Parameters:

fieldValues - the map containing the search fields and values

rows -

Returns:

true if consolidation is selected and subaccount is not specified

isConsolidationSelected

boolean isConsolidationSelected(Map fieldValues)

This method tests if the user selects to see the details or consolidated results

Parameters:

fieldValues - the map containing the search fields and values

Returns:

true if consolidation is selected and subaccount is not specified

updateLedgerBalanceByPendingLedgerEntry

void updateLedgerBalanceByPendingLedgerEntry(Collection<LedgerBalance> balanceCollection,
                                             Map fieldValues,
                                             String pendingEntryOption,
                                             boolean isConsolidated)

update a given balance collection with the pending entry obtained from the given field values and pending entry option

Parameters:

balanceCollection - the given ledger balance collection

fieldValues - the given field values

pendingEntryOption - the given pending entry option: all, approved or none

isConsolidated - indicate if the collection balances have been consolidated

See Also:

LedgerBalance

updateCurrentFundsByPendingLedgerEntry

void updateCurrentFundsByPendingLedgerEntry(Collection<AccountStatusCurrentFunds> balanceCollection,
                                            Map fieldValues,
                                            String pendingEntryOption,
                                            boolean isConsolidated)

update a given balance collection with the pending entry obtained from the given field values and pending entry option

Parameters:

balanceCollection - the given ledger balance collection

fieldValues - the given field values

pendingEntryOption - the given pending entry option: all, approved or none

isConsolidated - indicate if the collection balances have been consolidated

See Also:

LedgerBalance

updateLedgerEntryByPendingLedgerEntry

void updateLedgerEntryByPendingLedgerEntry(Collection<LedgerEntry> entryCollection,
                                           Map fieldValues,
                                           String pendingEntryOption)

update a given ledger entry collection with the pending entry obtained from the given field values and pending entry option

Parameters:

entryCollection - the given ledger entry collection

fieldValues - the given field values

pendingEntryOption - the given pending entry option: all, approved or none

See Also:

LedgerEntry

getSelectedPendingEntryOption

String getSelectedPendingEntryOption(Map fieldValues)

Get the Pending Entry Option selected

Parameters:

fieldValues -

Returns:

String