org.kuali.kfs.module.ld.businessobject.inquiry
Class AbstractLaborInquirableImpl

java.lang.Object
  org.kuali.rice.kns.inquiry.KualiInquirableImpl
      org.kuali.kfs.sys.businessobject.inquiry.KfsInquirableImpl
          org.kuali.kfs.module.ld.businessobject.inquiry.AbstractLaborInquirableImpl

All Implemented Interfaces:

org.kuali.rice.kns.inquiry.Inquirable

Direct Known Subclasses:

BaseFundsInquirableImpl, CurrentFundsInquirableImpl, EmployeeFundingInquirableImpl, July1PositionFundingInquirableImpl, LaborCalculatedSalaryFoundationTrackerInquirableImpl, LedgerBalanceInquirableImpl, LedgerPendingEntryInquirableImpl, PositionDataDetailsInquirableImpl, PositionDataInquirableImpl, PositionFundingInquirableImpl

public abstract class AbstractLaborInquirableImpl
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

AbstractLaborInquirableImpl()

Method Summary

protected 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
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.
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
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 boolean	isExclusiveFieldToBeALink(Object keyName, Object keyValue) This method determines whether the input name-value pair is exclusive to be a link

Methods inherited from class org.kuali.kfs.sys.businessobject.inquiry.KfsInquirableImpl

getInquiryUrl

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

AbstractLaborInquirableImpl

public AbstractLaborInquirableImpl()

Method Detail

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:

key list

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 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

isExclusiveFieldToBeALink

protected boolean isExclusiveFieldToBeALink(Object keyName,
                                            Object keyValue)

This method determines whether the input name-value pair is exclusive to be a link

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