org.kuali.kfs.coa.document.web
Class ObjectLevelCodeDescriptionFormatter

java.lang.Object
  org.kuali.kfs.sys.document.web.CodeDescriptionFormatterBase
      org.kuali.kfs.coa.document.web.ObjectLevelCodeDescriptionFormatter

All Implemented Interfaces:

CodeDescriptionFormatter

public class ObjectLevelCodeDescriptionFormatter
extends CodeDescriptionFormatterBase

This class...

Field Summary

Fields inherited from class org.kuali.kfs.sys.document.web.CodeDescriptionFormatterBase

DEFAULT_DESCRIPTION, INIT_BUFFER_SIZE

Constructor Summary

ObjectLevelCodeDescriptionFormatter(String chartOfAccountsCode)

Method Summary

protected String

getDescriptionOfBO(org.kuali.rice.kns.bo.PersistableBusinessObject bo) Returns the description of a BO

protected Map<String,org.kuali.rice.kns.bo.PersistableBusinessObject>

getValuesToBusinessObjectsMap(Set values) Returns a Map such that the values in the values set will map to the appropriate BO There may be mappings for values that are not in the parameter set Use this method sparingly, as it will likely cause an access to the DB It may be desirable to use the values to limit the breadth of the search, and it is up to the implementation to decide whether to use it to do so.

Methods inherited from class org.kuali.kfs.sys.document.web.CodeDescriptionFormatterBase

getDefaultDescription, getFormattedStringWithDescriptions

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectLevelCodeDescriptionFormatter

public ObjectLevelCodeDescriptionFormatter(String chartOfAccountsCode)

Method Detail

getDescriptionOfBO

protected String getDescriptionOfBO(org.kuali.rice.kns.bo.PersistableBusinessObject bo)

Description copied from class: CodeDescriptionFormatterBase

Returns the description of a BO

Specified by:

getDescriptionOfBO in class CodeDescriptionFormatterBase

Returns:

See Also:

org.kuali.kfs.sys.document.web.CodeDescriptionFormatterBase#getDescriptionOfBO(org.kuali.rice.kns.bo.BusinessObject)

getValuesToBusinessObjectsMap

protected Map<String,org.kuali.rice.kns.bo.PersistableBusinessObject> getValuesToBusinessObjectsMap(Set values)

Description copied from class: CodeDescriptionFormatterBase

Returns a Map such that the values in the values set will map to the appropriate BO There may be mappings for values that are not in the parameter set Use this method sparingly, as it will likely cause an access to the DB It may be desirable to use the values to limit the breadth of the search, and it is up to the implementation to decide whether to use it to do so.

Specified by:

getValuesToBusinessObjectsMap in class CodeDescriptionFormatterBase

Parameters:

values - a set of values to limit the retrieval from (optional feature), may be null

Returns:

a map from value string to BO

See Also:

CodeDescriptionFormatterBase.getValuesToBusinessObjectsMap(java.util.Set)