org.kuali.rice.kns.lookup
Class DictionaryLookupableHelperServiceImpl

java.lang.Object
  org.kuali.rice.kns.lookup.AbstractLookupableHelperServiceImpl
      org.kuali.rice.kns.lookup.DictionaryLookupableHelperServiceImpl

All Implemented Interfaces:

Serializable, LookupableHelperService

public class DictionaryLookupableHelperServiceImpl
extends AbstractLookupableHelperServiceImpl

See Also:

Serialized Form

Field Summary

private static List	IGNORED_FIELDS
private static org.apache.log4j.Logger	LOG
private static long	serialVersionUID

Fields inherited from class org.kuali.rice.kns.lookup.AbstractLookupableHelperServiceImpl

ACTION_URLS_CHILDREN_END, ACTION_URLS_CHILDREN_SEPARATOR, ACTION_URLS_CHILDREN_STARTER, ACTION_URLS_EMPTY, ACTION_URLS_SEPARATOR, backLocation, businessObjectAuthorizationService, businessObjectClass, businessObjectDictionaryService, businessObjectMetaDataService, businessObjectService, configurationService, dataDictionaryService, docFormKey, docNum, encryptionService, fieldConversions, forceLookupResultFieldInquiryCache, inquirableClassCache, kualiInquirable, lookupResultsService, lookupService, maintenanceDocumentDictionaryService, noLookupResultFieldInquiryCache, parameters, parameterService, persistenceStructureService, readOnlyFieldsList, referencesToRefresh, resultColumns, RESULTS_DEFAULT_MAX_COLUMN_LENGTH, rows, sequenceAccessorService, TITLE_ACTION_URL_PREPENDTEXT_PROPERTY, TITLE_RETURN_URL_PREPENDTEXT_PROPERTY

Constructor Summary

DictionaryLookupableHelperServiceImpl()

Method Summary

protected String	getActionUrlHref(BusinessObject businessObject, String methodToCall, List pkNames) TODO: Revisit whether this method is needed here at all
List	getDefaultReturnType()
List	getReturnKeys() This method is public because some unit tests depend on it.
HtmlData	getReturnUrl(BusinessObject bo, LookupForm lookupForm, List returnKeys, BusinessObjectRestrictions businessObjectRestrictions) This method builds the return url
List	getSearchResults(Map<String,String> fieldValues) Performs a search and returns result list.
List	getSearchResults(Map fieldValues, Map fieldConversions) Overrides the default lookupable search to provide a search against the BusinessObjectDictionaryService to retrieve attribute definitions.

Methods inherited from class org.kuali.rice.kns.lookup.AbstractLookupableHelperServiceImpl

addToReturnHref, allowsMaintenanceDeleteAction, allowsMaintenanceEditAction, allowsMaintenanceNewOrCopyAction, allowsNewOrCopyAction, applyConditionalLogicForFieldDisplay, applyFieldAuthorizationsFromNestedLookups, checkForAdditionalFields, getActionUrls, getActionUrlTitleText, getBackLocation, getBusinessObjectAuthorizationService, getBusinessObjectClass, getBusinessObjectDictionaryService, getBusinessObjectMetaDataService, getBusinessObjectService, getColumnMaxLength, getColumns, getConditionallyHiddenPropertyNames, getConditionallyReadOnlyPropertyNames, getConditionallyRequiredPropertyNames, getCurrentSearchFieldValue, getCustomActionUrls, getDataDictionaryService, getDefaultSortColumns, getDocFormKey, getDocNum, getEmptyActionUrls, getEmptyAnchorHtmlData, getEncryptionService, getExtraField, getInquiryUrl, getKualiConfigurationService, getKualiInquirable, getLookupResultsService, getLookupService, getMaintenanceDocumentDictionaryService, getMaintenanceDocumentTypeName, getMaintenanceUrl, getParameters, getParameters, getParameterService, getParametersFromPrimaryKey, getPersistenceStructureService, getPrimaryKeyFieldLabels, getPropertyClass, getReadOnlyFieldsList, getReferencesToRefresh, getReturnAnchorHtmlData, getReturnHref, getReturnHref, getReturnInputHtmlData, getReturnLocation, getReturnUrl, getRows, getSearchResultsUnbounded, getSequenceAccessorService, getSupplementalMenuBar, getTitle, getUrlData, getUrlData, isResultReturnable, isSearchUsingOnlyPrimaryKeyValues, maskValueIfNecessary, performClear, performCustomAction, performLookup, preprocessDateFields, setBackLocation, setBusinessObjectClass, setBusinessObjectDictionaryService, setBusinessObjectMetaDataService, setBusinessObjectService, setDataDictionaryService, setDocFormKey, setDocNum, setEncryptionService, setFieldConversions, setKualiInquirable, setLookupResultsService, setLookupService, setMaintenanceDocumentDictionaryService, setParameters, setParameterService, setParameterService, setPersistenceStructureService, setReadOnlyFieldsList, setReferencesToRefresh, setRows, setSequenceAccessorService, shouldDisplayHeaderNonMaintActions, shouldDisplayLookupCriteria, validateSearchParameters, validateSearchParameterWildcardAndOperators

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

LOG

private static final org.apache.log4j.Logger LOG

IGNORED_FIELDS

private static final List IGNORED_FIELDS

Constructor Detail

DictionaryLookupableHelperServiceImpl

public DictionaryLookupableHelperServiceImpl()

Method Detail

getSearchResults

public List getSearchResults(Map<String,String> fieldValues)

Description copied from interface: LookupableHelperService

Performs a search and returns result list.

Specified by:

getSearchResults in interface LookupableHelperService

Specified by:

getSearchResults in class AbstractLookupableHelperServiceImpl

Parameters:

fieldValues - - Map of property/value pairs

Returns:

List of business objects found by the search

getSearchResults

public List getSearchResults(Map fieldValues,
                             Map fieldConversions)

Overrides the default lookupable search to provide a search against the BusinessObjectDictionaryService to retrieve attribute definitions.

getReturnUrl

public HtmlData getReturnUrl(BusinessObject bo,
                             LookupForm lookupForm,
                             List returnKeys,
                             BusinessObjectRestrictions businessObjectRestrictions)

Description copied from interface: LookupableHelperService

This method builds the return url

Specified by:

getReturnUrl in interface LookupableHelperService

Overrides:

getReturnUrl in class AbstractLookupableHelperServiceImpl

Returns:

See Also:

org.kuali.rice.kns.lookup.Lookupable#getReturnUrl(java.lang.Object, java.util.Map, java.lang.String)

getActionUrlHref

protected String getActionUrlHref(BusinessObject businessObject,
                                  String methodToCall,
                                  List pkNames)

TODO: Revisit whether this method is needed here at all

Overrides:

getActionUrlHref in class AbstractLookupableHelperServiceImpl

Returns:

See Also:

AbstractLookupableHelperServiceImpl.getActionUrlHref(org.kuali.rice.kns.bo.BusinessObject, java.lang.String, java.util.List)

getDefaultReturnType

public List getDefaultReturnType()

See Also:

org.kuali.rice.kns.lookup.Lookupable#getDefaultReturnType()

getReturnKeys

public List getReturnKeys()

Description copied from interface: LookupableHelperService

This method is public because some unit tests depend on it.

Specified by:

getReturnKeys in interface LookupableHelperService

Overrides:

getReturnKeys in class AbstractLookupableHelperServiceImpl

Returns:

a List of the names of fields which are marked in data dictionary as return fields.

See Also:

KualiLookupableImpl.getReturnKeys()