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

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

All Implemented Interfaces:

org.kuali.rice.kns.inquiry.Inquirable

Direct Known Subclasses:

AccountBalanceByConsolidationInquirableImpl, AccountBalanceByLevelInquirableImpl, AccountBalanceByObjectInquirableImpl, AccountBalanceInquirableImpl, BalanceInquirableImpl, CashBalanceInquirableImpl, EffortLedgerBalanceInquirableImpl, EncumbranceInquirableImpl, EntryInquirableImpl

public abstract class AbstractGeneralLedgerInquirableImpl
extends KfsInquirableImpl

This class is the template class for the customized inqurable implementations used to generate balance inquiry screens.

Field Summary

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

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

Constructor Summary

AbstractGeneralLedgerInquirableImpl()

Method Summary

protected abstract void	addMoreParameters(Properties parameter, String attributeName) This method adds more parameters into the curren parameter map
protected abstract List	buildUserDefinedAttributeKeyList() This method builds the inquiry url for user-defined attribute
protected abstract String	getAttributeName(String attributeName) This method finds the matching attribute name of given one
protected abstract String	getBaseUrl() This method defines the base inquiry url
org.kuali.rice.kns.bo.BusinessObject	getBusinessObject() Gets the businessObject attribute.
protected org.kuali.rice.kns.lookup.HtmlData	getDocTypeInquiryUrl(String docTypeCode) Builds URL to document type inquiry based on a given document type code
Map	getFieldValues(Map fieldValues) This takes a map of field values and then returns it without processing it, making this a sort of identity method for Maps
protected abstract Class	getInquiryBusinessObjectClass(String attributeName) This method gets the class name of the inquiry business object for a given attribute.
org.kuali.rice.kns.lookup.HtmlData	getInquiryUrl(org.kuali.rice.kns.bo.BusinessObject businessObject, String attributeName) Helper method to build an inquiry url for a result field.
org.kuali.rice.kns.lookup.HtmlData	getInquiryUrl(org.kuali.rice.kns.bo.BusinessObject businessObject, String attributeName, boolean forceInquiry) Helper method to build an inquiry url for a result field.
protected abstract String	getKeyName(String keyName) This method finds the matching the key name of the given one
protected abstract Object	getKeyValue(String keyName, Object keyValue) This method finds the matching the key value of the given one
protected abstract String	getLookupableImplAttributeName() This method defines the lookupable implementation attribute name
Class	getNestedInquiryBusinessObjectClass(org.kuali.rice.kns.bo.BusinessObject businessObject, String attributeName) Given the nested name of an attribute in an object, returns the class that attribute will return
protected abstract Map	getUserDefinedAttributeMap() This method defines the user-defined attribute map
protected boolean	isExclusiveField(Object keyName, Object keyValue) This method determines whether the input name-value pair is exclusive from the processing
protected String	recoverFieldValueFromConsolidation(Map fieldValues, Object keyName, Object keyValue) This method recovers the values of the given keys
void	setBusinessObject(org.kuali.rice.kns.bo.BusinessObject businessObject) Sets the businessObject attribute value.

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

AbstractGeneralLedgerInquirableImpl

public AbstractGeneralLedgerInquirableImpl()

Method Detail

getInquiryUrl

public org.kuali.rice.kns.lookup.HtmlData getInquiryUrl(org.kuali.rice.kns.bo.BusinessObject businessObject,
                                                        String attributeName,
                                                        boolean forceInquiry)

Description copied from class: KfsInquirableImpl

Helper method to build an inquiry url for a result field. Special implementation to not build an inquiry link if the value is all dashes.

Specified by:

getInquiryUrl in interface org.kuali.rice.kns.inquiry.Inquirable

Overrides:

getInquiryUrl in class KfsInquirableImpl

Returns:

String url to inquiry

See Also:

KfsInquirableImpl.getInquiryUrl(org.kuali.rice.kns.bo.BusinessObject, java.lang.String, boolean)

getInquiryUrl

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

Helper method to build an inquiry url for a result field.

Parameters:

businessObject - the business object instance to build the urls for

attributeName - the attribute name which links to an inquirable

Returns:

String url to inquiry

buildUserDefinedAttributeKeyList

protected abstract List buildUserDefinedAttributeKeyList()

This method builds the inquiry url for user-defined attribute

Returns:

a List of attribute keys for the inquiry url

getUserDefinedAttributeMap

protected abstract Map getUserDefinedAttributeMap()

This method defines the user-defined attribute map

Returns:

the user-defined attribute map

getAttributeName

protected abstract String getAttributeName(String attributeName)

This method finds the matching attribute name of given one

Parameters:

attributeName - the given attribute name

Returns:

the attribute name from the given one

getKeyValue

protected abstract Object getKeyValue(String keyName,
                                      Object keyValue)

This method finds the matching the key value of the given one

Parameters:

keyName - the given key name

keyValue - the given key value

Returns:

the key value from the given key value

getKeyName

protected abstract String getKeyName(String keyName)

This method finds the matching the key name of the given one

Parameters:

keyName - the given key name

Returns:

the key value from the given key name

getLookupableImplAttributeName

protected abstract String getLookupableImplAttributeName()

This method defines the lookupable implementation attribute name

Returns:

the lookupable implementation attribute name

getBaseUrl

protected abstract String getBaseUrl()

This method defines the base inquiry url

Returns:

the base inquiry url

getInquiryBusinessObjectClass

protected abstract Class getInquiryBusinessObjectClass(String attributeName)

This method gets the class name of the inquiry business object for a given attribute.

Returns:

the class name of the inquiry business object for a given attribute

addMoreParameters

protected abstract void addMoreParameters(Properties parameter,
                                          String attributeName)

This method adds more parameters into the curren parameter map

Parameters:

parameter - the current parameter map

isExclusiveField

protected boolean isExclusiveField(Object keyName,
                                   Object keyValue)

This method determines whether the input name-value pair is exclusive from the processing

Parameters:

keyName - the name of the name-value pair

keyValue - the value of the name-value pair

Returns:

true if the input key is in the exclusive list; otherwise, false

recoverFieldValueFromConsolidation

protected String recoverFieldValueFromConsolidation(Map fieldValues,
                                                    Object keyName,
                                                    Object keyValue)

This method recovers the values of the given keys

Parameters:

fieldValues - unconsolidated values

keyName - a key name that may be in the fieldValues map

keyValue - a key value that may be in the fieldValues map

Returns:

the original value for a previously consolidated value

getFieldValues

public Map getFieldValues(Map fieldValues)

This takes a map of field values and then returns it without processing it, making this a sort of identity method for Maps

Parameters:

fieldValues - field values to return to the user

Returns:

the Map you sent in as a parameter

getNestedInquiryBusinessObjectClass

public Class getNestedInquiryBusinessObjectClass(org.kuali.rice.kns.bo.BusinessObject businessObject,
                                                 String attributeName)

Given the nested name of an attribute in an object, returns the class that attribute will return

Parameters:

businessObject - the business object to find the propery class for

attributeName - the nested name of the attribute to find the class for

Returns:

the class of the nested attribute

getDocTypeInquiryUrl

protected org.kuali.rice.kns.lookup.HtmlData getDocTypeInquiryUrl(String docTypeCode)

Builds URL to document type inquiry based on a given document type code

Parameters:

docTypeCode - - document type code to inquiry on

Returns:

HtmlData representing inquiry URL

getBusinessObject

public org.kuali.rice.kns.bo.BusinessObject getBusinessObject()

Gets the businessObject attribute.

Returns:

Returns the businessObject.

setBusinessObject

public void setBusinessObject(org.kuali.rice.kns.bo.BusinessObject businessObject)

Sets the businessObject attribute value.

Parameters:

businessObject - The businessObject to set.