org.kuali.kfs.gl.businessobject.lookup
Class AbstractGeneralLedgerLookupableHelperServiceImpl

java.lang.Object
  org.kuali.rice.kns.lookup.AbstractLookupableHelperServiceImpl
      org.kuali.kfs.gl.businessobject.lookup.AbstractGeneralLedgerLookupableHelperServiceImpl

All Implemented Interfaces:

Serializable, org.kuali.rice.kns.lookup.LookupableHelperService

Direct Known Subclasses:

AccountBalanceLookupableHelperServiceImpl, BalanceLookupableHelperServiceImpl, CashBalanceLookupableHelperServiceImpl, EncumbranceLookupableHelperServiceImpl, EntryLookupableHelperServiceImpl

public abstract class AbstractGeneralLedgerLookupableHelperServiceImpl
extends org.kuali.rice.kns.lookup.AbstractLookupableHelperServiceImpl

The abstract parent class for GL Lookupables, providing base implementations of methods to make adding new lookupable reports easier

See Also:

Serialized Form

Field Summary

Fields inherited from class org.kuali.rice.kns.lookup.AbstractLookupableHelperServiceImpl

ACTION_URLS_CHILDREN_END, ACTION_URLS_CHILDREN_SEPARATOR, ACTION_URLS_CHILDREN_STARTER, ACTION_URLS_EMPTY, ACTION_URLS_SEPARATOR, backLocation, businessObjectAuthorizationService, businessObjectClass, businessObjectDictionaryService, businessObjectMetaDataService, businessObjectService, configurationService, dataDictionaryService, docFormKey, docNum, encryptionService, fieldConversions, forceLookupResultFieldInquiryCache, inquirableClassCache, kualiInquirable, lookupResultsService, lookupService, maintenanceDocumentDictionaryService, noLookupResultFieldInquiryCache, parameters, parameterService, persistenceStructureService, readOnlyFieldsList, referencesToRefresh, resultColumns, RESULTS_DEFAULT_MAX_COLUMN_LENGTH, rows, sequenceAccessorService, TITLE_ACTION_URL_PREPENDTEXT_PROPERTY, TITLE_RETURN_URL_PREPENDTEXT_PROPERTY

Constructor Summary

AbstractGeneralLedgerLookupableHelperServiceImpl()

Method Summary

protected List	buildSearchResultList(Collection searchResultsCollection, Long actualSize) build the serach result list from the given collection and the number of all qualified search results
List<org.kuali.rice.kns.lookup.HtmlData>	getCustomActionUrls(org.kuali.rice.kns.bo.BusinessObject bo, List pkNames) This method overides that in parent class so that the maintainance actions are surpressed
protected GeneralLedgerPendingEntryService	getGeneralLedgerPendingEntryService()
protected String	getSelectedAmountViewOption(Map fieldValues) This method tests if the user selects to see the reports by monthly or accumulated
protected String	getSelectedPendingEntryOption(Map fieldValues) This method tests if the user selects to see the general ledager pending entries
protected boolean	isConsolidationSelected(Map fieldValues) This method tests if the user selects to see the details or consolidated results
protected boolean	isCostShareInclusive(Map fieldValues) This method tests if the user selects to see the results with cost share subaccount
void	setGeneralLedgerPendingEntryService(GeneralLedgerPendingEntryService generalLedgerPendingEntryService)
protected void	updateByPendingLedgerEntry(Collection entryCollection, Map fieldValues, String pendingEntryOption, boolean isConsolidated, boolean isCostShareInclusive) This method is used to update amounts of the given entries with the corresponding pending amounts.
protected abstract void	updateEntryCollection(Collection entryCollection, Map fieldValues, boolean isApproved, boolean isConsolidated, boolean isCostShareInclusive) This method is an abstract method and implemented to update the given entry collection by the children classes.

Methods inherited from class org.kuali.rice.kns.lookup.AbstractLookupableHelperServiceImpl

addToReturnHref, allowsMaintenanceDeleteAction, allowsMaintenanceEditAction, allowsMaintenanceNewOrCopyAction, allowsNewOrCopyAction, applyConditionalLogicForFieldDisplay, applyFieldAuthorizationsFromNestedLookups, checkForAdditionalFields, getActionUrlHref, getActionUrls, getActionUrlTitleText, getBackLocation, getBusinessObjectAuthorizationService, getBusinessObjectClass, getBusinessObjectDictionaryService, getBusinessObjectMetaDataService, getBusinessObjectService, getColumnMaxLength, getColumns, getConditionallyHiddenPropertyNames, getConditionallyReadOnlyPropertyNames, getConditionallyRequiredPropertyNames, getCurrentSearchFieldValue, getDataDictionaryService, getDefaultSortColumns, getDocFormKey, getDocNum, getEmptyActionUrls, getEmptyAnchorHtmlData, getEncryptionService, getExtraField, getInquiryUrl, getKualiConfigurationService, getKualiInquirable, getLookupResultsService, getLookupService, getMaintenanceDocumentDictionaryService, getMaintenanceDocumentTypeName, getMaintenanceUrl, getParameters, getParameters, getParameterService, getParametersFromPrimaryKey, getPersistenceStructureService, getPrimaryKeyFieldLabels, getPropertyClass, getReadOnlyFieldsList, getReferencesToRefresh, getReturnAnchorHtmlData, getReturnHref, getReturnHref, getReturnInputHtmlData, getReturnKeys, getReturnLocation, getReturnUrl, getReturnUrl, getRows, getSearchResults, getSearchResultsUnbounded, getSequenceAccessorService, getSupplementalMenuBar, getTitle, getUrlData, getUrlData, isResultReturnable, isSearchUsingOnlyPrimaryKeyValues, maskValueIfNecessary, performClear, performCustomAction, performLookup, preprocessDateFields, setBackLocation, setBusinessObjectClass, setBusinessObjectDictionaryService, setBusinessObjectMetaDataService, setBusinessObjectService, setDataDictionaryService, setDocFormKey, setDocNum, setEncryptionService, setFieldConversions, setKualiInquirable, setLookupResultsService, setLookupService, setMaintenanceDocumentDictionaryService, setParameters, setParameterService, setParameterService, setPersistenceStructureService, setReadOnlyFieldsList, setReferencesToRefresh, setRows, setSequenceAccessorService, shouldDisplayHeaderNonMaintActions, shouldDisplayLookupCriteria, validateSearchParameters, validateSearchParameterWildcardAndOperators

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractGeneralLedgerLookupableHelperServiceImpl

public AbstractGeneralLedgerLookupableHelperServiceImpl()

Method Detail

getGeneralLedgerPendingEntryService

protected GeneralLedgerPendingEntryService getGeneralLedgerPendingEntryService()

setGeneralLedgerPendingEntryService

public void setGeneralLedgerPendingEntryService(GeneralLedgerPendingEntryService generalLedgerPendingEntryService)

getCustomActionUrls

public List<org.kuali.rice.kns.lookup.HtmlData> getCustomActionUrls(org.kuali.rice.kns.bo.BusinessObject bo,
                                                                    List pkNames)

This method overides that in parent class so that the maintainance actions are surpressed

Specified by:

getCustomActionUrls in interface org.kuali.rice.kns.lookup.LookupableHelperService

Overrides:

getCustomActionUrls in class org.kuali.rice.kns.lookup.AbstractLookupableHelperServiceImpl

getSelectedPendingEntryOption

protected String getSelectedPendingEntryOption(Map fieldValues)

This method tests if the user selects to see the general ledager pending entries

Parameters:

fieldValues - the map containing the search fields and values

Returns:

the value of pending entry option

getSelectedAmountViewOption

protected String getSelectedAmountViewOption(Map fieldValues)

This method tests if the user selects to see the reports by monthly or accumulated

Parameters:

fieldValues - the map containing the search fields and values

Returns:

the value of amount view option

isConsolidationSelected

protected 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

isCostShareInclusive

protected boolean isCostShareInclusive(Map fieldValues)

This method tests if the user selects to see the results with cost share subaccount

Parameters:

fieldValues - the map containing the search fields and values

Returns:

true if inclusive option is selected

buildSearchResultList

protected List buildSearchResultList(Collection searchResultsCollection,
                                     Long actualSize)

build the serach result list from the given collection and the number of all qualified search results

Parameters:

searchResultsCollection - the given search results, which may be a subset of the qualified search results

actualSize - the number of all qualified search results

Returns:

the serach result list with the given results and actual size

updateByPendingLedgerEntry

protected void updateByPendingLedgerEntry(Collection entryCollection,
                                          Map fieldValues,
                                          String pendingEntryOption,
                                          boolean isConsolidated,
                                          boolean isCostShareInclusive)

This method is used to update amounts of the given entries with the corresponding pending amounts. It is a factory that executes the update methods of individual derived classes.

Parameters:

entryCollection - a collection of balance entries

fieldValues - the map containing the search fields and values

pendingEntryOption - flag whether the approved entries or all entries will be processed

isCostShareInclusive - flag whether the user selects to see the results with cost share subaccount

isConsolidated - flag whether the results are consolidated or not

updateEntryCollection

protected abstract void updateEntryCollection(Collection entryCollection,
                                              Map fieldValues,
                                              boolean isApproved,
                                              boolean isConsolidated,
                                              boolean isCostShareInclusive)

This method is an abstract method and implemented to update the given entry collection by the children classes. It is called by updateByPendingLedgerEntry method.

Parameters:

entryCollection - a collection of balance entries

fieldValues - the map containing the search fields and values

isApproved - flag whether the approved entries or all entries will be processed

isCostShareInclusive - flag whether the user selects to see the results with cost share subaccount

isConsolidated - flag whether the results are consolidated or not