org.kuali.kfs.gl.businessobject.inquiry
Class BalanceInquirableImpl

java.lang.Object
  org.kuali.rice.kns.inquiry.KualiInquirableImpl
      org.kuali.kfs.sys.businessobject.inquiry.KfsInquirableImpl
          org.kuali.kfs.gl.businessobject.inquiry.AbstractGeneralLedgerInquirableImpl
              org.kuali.kfs.gl.businessobject.inquiry.BalanceInquirableImpl

All Implemented Interfaces:

org.kuali.rice.kns.inquiry.Inquirable

public class BalanceInquirableImpl
extends AbstractGeneralLedgerInquirableImpl

This class is used to generate the URL for the user-defined attributes for the GL balace screen. It is entended the KualiInquirableImpl class, so it covers both the default implementation and customized implemetnation.

Field Summary

Fields inherited from class org.kuali.rice.kns.inquiry.KualiInquirableImpl

businessObjectDictionaryService, businessObjectMetaDataService, businessObjectService, dataDictionaryService, encryptionService, inactiveRecordDisplay, INQUIRY_TITLE_PREFIX, kualiConfigurationService, persistenceStructureService, SUPER_CLASS_TRANSLATOR_LIST

Constructor Summary

BalanceInquirableImpl()

Method Summary

protected void	addMoreParameters(Properties parameter, String attributeName) Addes the lookup impl and period code attributes to the parameters
protected List	buildUserDefinedAttributeKeyList() Builds the keys for this inquiry.
protected String	getAttributeName(String attributeName) Changes the name of attributes on the fly...in this case, this just always returns the attribute name it's handed
protected String	getBaseUrl() Return the page name of this lookup
protected Class	getInquiryBusinessObjectClass(String attributeName) Retrieves the business class of the next class type to drill up...since balance summarizes entry, it's entry
protected String	getKeyName(String keyName) Justs returns the key name given
protected Object	getKeyValue(String keyName, Object keyValue) If the key name sent in represents an "exclusive field", returns "" as the key value
protected String	getLookupableImplAttributeName() Return a Spring bean for the lookup
protected Map	getUserDefinedAttributeMap() The addition of all the month amounts, plus beginning balance and c&g balance as attributes

Methods inherited from class org.kuali.kfs.gl.businessobject.inquiry.AbstractGeneralLedgerInquirableImpl

getBusinessObject, getDocTypeInquiryUrl, getFieldValues, getInquiryUrl, getInquiryUrl, getNestedInquiryBusinessObjectClass, isExclusiveField, recoverFieldValueFromConsolidation, setBusinessObject

Methods inherited from class org.kuali.rice.kns.inquiry.KualiInquirableImpl

addAdditionalSections, createTitleText, getBusinessObject, getBusinessObjectClass, getBusinessObjectDictionaryService, getBusinessObjectMetaDataService, getBusinessObjectService, getDataDictionaryService, getEncryptionService, getHtmlMenuBar, getHyperLink, getHyperLink, getInactiveRecordDisplay, getInquiryUrlForPrimaryKeys, getKualiConfigurationService, getLookupService, getPersistenceStructureService, getSections, getShowInactiveRecords, getTitle, setBusinessObjectClass, setBusinessObjectDictionaryService, setBusinessObjectMetaDataService, setDataDictionaryService, setEncryptionService, setKualiConfigurationService, setLookupService, setPersistenceStructureService, setShowInactiveRecords

Methods inherited from class java.lang.Object

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

Constructor Detail

BalanceInquirableImpl

public BalanceInquirableImpl()

Method Detail

buildUserDefinedAttributeKeyList

protected List buildUserDefinedAttributeKeyList()

Builds the keys for this inquiry.

Specified by:

buildUserDefinedAttributeKeyList in class AbstractGeneralLedgerInquirableImpl

Returns:

a List of Strings, holding the keys of this inquiry

See Also:

AbstractGeneralLedgerInquirableImpl.buildUserDefinedAttributeKeyList()

getUserDefinedAttributeMap

protected Map getUserDefinedAttributeMap()

The addition of all the month amounts, plus beginning balance and c&g balance as attributes

Specified by:

getUserDefinedAttributeMap in class AbstractGeneralLedgerInquirableImpl

Returns:

a Map of user defined attributes

See Also:

AbstractGeneralLedgerInquirableImpl.getUserDefinedAttributeMap()

getAttributeName

protected String getAttributeName(String attributeName)

Changes the name of attributes on the fly...in this case, this just always returns the attribute name it's handed

Specified by:

getAttributeName in class AbstractGeneralLedgerInquirableImpl

Parameters:

attributeName - the attribute to rename

Returns:

a String with the new attribute name

See Also:

AbstractGeneralLedgerInquirableImpl.getAttributeName(java.lang.String)

getKeyValue

protected Object getKeyValue(String keyName,
                             Object keyValue)

If the key name sent in represents an "exclusive field", returns "" as the key value

Specified by:

getKeyValue in class AbstractGeneralLedgerInquirableImpl

Parameters:

keyName - the name of the key that may be changed

keyValue - the value of the key that may be changed

Returns:

an Object with the perhaps modified value for the key

See Also:

AbstractGeneralLedgerInquirableImpl.getKeyValue(java.lang.String, java.lang.Object)

getKeyName

protected String getKeyName(String keyName)

Justs returns the key name given

Specified by:

getKeyName in class AbstractGeneralLedgerInquirableImpl

Parameters:

keyName - a key name

Returns:

the key name given

See Also:

AbstractGeneralLedgerInquirableImpl.getKeyName(java.lang.String)

getLookupableImplAttributeName

protected String getLookupableImplAttributeName()

Return a Spring bean for the lookup

Specified by:

getLookupableImplAttributeName in class AbstractGeneralLedgerInquirableImpl

Returns:

the name of the Spring bean of the lookup

See Also:

AbstractGeneralLedgerInquirableImpl.getLookupableImplAttributeName()

getBaseUrl

protected String getBaseUrl()

Return the page name of this lookup

Specified by:

getBaseUrl in class AbstractGeneralLedgerInquirableImpl

Returns:

the page name for all GL lookups

See Also:

AbstractGeneralLedgerInquirableImpl.getBaseUrl()

getInquiryBusinessObjectClass

protected Class getInquiryBusinessObjectClass(String attributeName)

Retrieves the business class of the next class type to drill up...since balance summarizes entry, it's entry

Specified by:

getInquiryBusinessObjectClass in class AbstractGeneralLedgerInquirableImpl

Parameters:

attributeName - the name to build the inquiry link to

Returns:

the Class of the business object that should be inquired on

See Also:

AbstractGeneralLedgerInquirableImpl.getInquiryBusinessObjectClass(String)

addMoreParameters

protected void addMoreParameters(Properties parameter,
                                 String attributeName)

Addes the lookup impl and period code attributes to the parameters

Specified by:

addMoreParameters in class AbstractGeneralLedgerInquirableImpl

Parameters:

parameter - the parameters used in the lookup

attributeName - the attribute name that an inquiry URL is being built for

See Also:

AbstractGeneralLedgerInquirableImpl.addMoreParameters(java.util.Properties, java.lang.String)