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

java.lang.Object
  extended by org.kuali.rice.kns.inquiry.KualiInquirableImpl
      extended by org.kuali.kfs.sys.businessobject.inquiry.KfsInquirableImpl
          extended by org.kuali.kfs.gl.businessobject.inquiry.AbstractGeneralLedgerInquirableImpl
              extended by org.kuali.kfs.gl.businessobject.inquiry.AccountBalanceInquirableImpl
All Implemented Interfaces:
org.kuali.rice.kns.inquiry.Inquirable

public class AccountBalanceInquirableImpl
extends AbstractGeneralLedgerInquirableImpl

This class is used to generate the URL for the user-defined attributes for available account balace screen. It is entended the AbstractGeneralLedgerInquirableImpl 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
AccountBalanceInquirableImpl()
           
 
Method Summary
protected  void addMoreParameters(Properties parameter, String attributeName)
          Addes the lookup impl and balance type 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, doesn't do anything
protected  String getBaseUrl()
          Return the page name of this lookup
protected  Class getInquiryBusinessObjectClass(String attributeName)
          Retrieves the business class to use as the basis of an inquiry for the given attribute; in this case, it's always Balance
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 drill up lookup, which is the balance lookup
protected  Map getUserDefinedAttributeMap()
          The addition of user attributes - current budget, actual budget, and encumbrance balance
 
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

AccountBalanceInquirableImpl

public AccountBalanceInquirableImpl()
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 user attributes - current budget, actual budget, and encumbrance balance

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, doesn't do anything

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 drill up lookup, which is the balance 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 inquiry options
See Also:
AbstractGeneralLedgerInquirableImpl.getBaseUrl()

getInquiryBusinessObjectClass

protected Class getInquiryBusinessObjectClass(String attributeName)
Retrieves the business class to use as the basis of an inquiry for the given attribute; in this case, it's always Balance

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 balance type 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)


Copyright © 2005-2012 The Kuali Foundation. All Rights Reserved.