org.kuali.ole.gl.businessobject.lookup

Class EncumbranceLookupableHelperServiceImpl

java.lang.Object

org.kuali.rice.kns.lookup.AbstractLookupableHelperServiceImpl

org.kuali.ole.gl.businessobject.lookup.AbstractGeneralLedgerLookupableHelperServiceImpl

org.kuali.ole.gl.businessobject.lookup.EncumbranceLookupableHelperServiceImpl

All Implemented Interfaces:

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

public class EncumbranceLookupableHelperServiceImpl
extends AbstractGeneralLedgerLookupableHelperServiceImpl

An extension of KualiLookupableImpl to support encumbrance lookups

See Also:

Serialized Form

Field Summary

Fields inherited from class org.kuali.ole.gl.businessobject.lookup.AbstractGeneralLedgerLookupableHelperServiceImpl

debitDeterminerService, generalLedgerPendingEntryService

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

Constructors

Constructor and Description
EncumbranceLookupableHelperServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	allRequiredsForAccountSearch(Map fieldValues) Determines if all the required values for an account based search are present - fiscal year, chart, account number, and fiscal period code
protected boolean	allRequiredsForDocumentSearch(Map fieldValues) Determines if all the required values for an document based search are present - fiscal year and document number
org.kuali.rice.kns.lookup.HtmlData	getInquiryUrl(org.kuali.rice.krad.bo.BusinessObject businessObject, String propertyName) Returns the url for any drill down links within the lookup
List	getSearchResults(Map fieldValues) Generates the list of search results for this inquiry
protected String	getSelectedZeroEncumbranceOption(Map fieldValues) Method tests to see if the user selected to include or exclude zero encumbrances
void	setEncumbranceService(EncumbranceService encumbranceService) Sets the encumbranceService attribute value.
void	setPostEncumbrance(EncumbranceCalculator postEncumbrance) Sets the postEncumbrance attribute value.
protected void	updateEntryCollection(Collection entryCollection, Map fieldValues, boolean isApproved, boolean isConsolidated, boolean isCostShareInclusive) Updates pending entries before their results are included in the lookup results
void	validateSearchParameters(Map fieldValues) Validates the fiscal year searched for in the inquiry

Methods inherited from class org.kuali.ole.gl.businessobject.lookup.AbstractGeneralLedgerLookupableHelperServiceImpl

buildSearchResultList, getCustomActionUrls, getDebitCreditOption, getDebitDeterminerService, getGeneralLedgerPendingEntryService, getSelectedAmountViewOption, getSelectedPendingEntryOption, isConsolidationSelected, isCostShareInclusive, performLookup, setDebitDeterminerService, setGeneralLedgerPendingEntryService, updateByDebitCreditOption, updateByPendingLedgerEntry

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, 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, getSearchResultsUnbounded, getSequenceAccessorService, getSupplementalMenuBar, getTitle, getUrlData, getUrlData, isResultReturnable, isSearchUsingOnlyPrimaryKeyValues, maskValueIfNecessary, performClear, performCustomAction, setBackLocation, setBusinessObjectClass, setBusinessObjectDictionaryService, setBusinessObjectMetaDataService, setBusinessObjectService, setDataDictionaryService, setDocFormKey, setDocNum, setEncryptionService, setFieldConversions, setKualiInquirable, setLookupResultsService, setLookupService, setMaintenanceDocumentDictionaryService, setParameters, setParameterService, setParameterService, setPersistenceStructureService, setReadOnlyFieldsList, setReferencesToRefresh, setRows, setSequenceAccessorService, shouldDisplayHeaderNonMaintActions, shouldDisplayLookupCriteria, validateSearchParameterWildcardAndOperators

Methods inherited from class java.lang.Object

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

Constructor Detail

EncumbranceLookupableHelperServiceImpl

public EncumbranceLookupableHelperServiceImpl()

Method Detail

getInquiryUrl

public org.kuali.rice.kns.lookup.HtmlData getInquiryUrl(org.kuali.rice.krad.bo.BusinessObject businessObject,
                                               String propertyName)

Returns the url for any drill down links within the lookup

Specified by:

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

Overrides:

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

Parameters:

bo - the business object with a property being drilled down on

propertyName - the name of the property being drilled down on

Returns:

a String with the URL of the property

See Also:

org.kuali.rice.kns.lookup.Lookupable#getInquiryUrl(org.kuali.rice.krad.bo.BusinessObject, java.lang.String)

validateSearchParameters

public void validateSearchParameters(Map fieldValues)

Validates the fiscal year searched for in the inquiry

Specified by:

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

Overrides:

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

Parameters:

fieldValues - the values of the query

See Also:

AbstractLookupableHelperServiceImpl.validateSearchParameters(java.util.Map)

allRequiredsForAccountSearch

protected boolean allRequiredsForAccountSearch(Map fieldValues)

Determines if all the required values for an account based search are present - fiscal year, chart, account number, and fiscal period code

Parameters:

fieldValues - field values to check

Returns:

true if all the account-based required search fields are present; false otherwise

allRequiredsForDocumentSearch

protected boolean allRequiredsForDocumentSearch(Map fieldValues)

Determines if all the required values for an document based search are present - fiscal year and document number

Parameters:

fieldValues - field values to check

Returns:

true if all the document-based required search fields are present; false otherwise

getSearchResults

public List getSearchResults(Map fieldValues)

Generates the list of search results for this inquiry

Specified by:

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

Specified by:

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

Parameters:

fieldValues - the field values of the query to carry out

Returns:

List the search results returned by the lookup

See Also:

Lookupable.getSearchResults(java.util.Map)

updateEntryCollection

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

Updates pending entries before their results are included in the lookup results

Specified by:

updateEntryCollection in class AbstractGeneralLedgerLookupableHelperServiceImpl

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

isConsolidated - flag whether the results are consolidated or not

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

See Also:

org.kuali.module.gl.web.lookupable.AbstractGLLookupableImpl#updateEntryCollection(java.util.Collection, java.util.Map, boolean, boolean, boolean)

getSelectedZeroEncumbranceOption

protected String getSelectedZeroEncumbranceOption(Map fieldValues)

Method tests to see if the user selected to include or exclude zero encumbrances

Parameters:

fieldValues - the lookup field values

Returns:

the value of the zero encumbrance option

setPostEncumbrance

public void setPostEncumbrance(EncumbranceCalculator postEncumbrance)

Sets the postEncumbrance attribute value.

Parameters:

postEncumbrance - The postEncumbrance to set.

setEncumbranceService

public void setEncumbranceService(EncumbranceService encumbranceService)

Sets the encumbranceService attribute value.

Parameters:

encumbranceService - The encumbranceService to set.