Package org.kuali.rice.kns.lookup
Class KualiLookupableHelperServiceImpl
java.lang.Object
org.kuali.rice.kns.lookup.AbstractLookupableHelperServiceImpl
org.kuali.rice.kns.lookup.KualiLookupableHelperServiceImpl
- All Implemented Interfaces:
Serializable,LookupableHelperService
@Deprecated
@Transactional
public class KualiLookupableHelperServiceImpl
extends AbstractLookupableHelperServiceImpl
Deprecated.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected static final org.apache.logging.log4j.LoggerDeprecated.protected booleanDeprecated.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
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected StringgetExternalBusinessObjectProperty(Object sampleBo, String propertyName) Deprecated.Get the name of the property which represents the ExternalizableBusinessObject for the given property.protected Class<? extends org.kuali.rice.krad.bo.ExternalizableBusinessObject> getExternalizableBusinessObjectClass(Class boClass, String propertyName) Deprecated.Given an property on the main BO class, return the defined type of the ExternalizableBusinessObject.getExternalizableBusinessObjectFieldValues(String eboPropertyName, Map<String, String> fieldValues) Deprecated.Return the EBO fieldValue entries explicitly for the given eboPropertyName.getExternalizableBusinessObjectProperties(Class boClass, Map<String, String> fieldValues) Deprecated.Get the complete list of all properties referenced in the fieldValues that are ExternalizableBusinessObjects.Deprecated.Returns a comma delimited list of primary key field labels, to be used on the UI to tell the user which fields were used to search These labels are generated from the DD definitions for the lookup fieldsList<? extends org.kuali.rice.krad.bo.BusinessObject> getSearchResults(Map<String, String> fieldValues) Deprecated.Uses Lookup Service to provide a basic search.protected List<? extends org.kuali.rice.krad.bo.BusinessObject> getSearchResultsHelper(Map<String, String> fieldValues, boolean unbounded) Deprecated.This method does the actual search, with the parameters specified, and returns the result.List<? extends org.kuali.rice.krad.bo.BusinessObject> getSearchResultsUnbounded(Map<String, String> fieldValues) Deprecated.Uses Lookup Service to provide a basic unbounded search.protected booleanhasExternalBusinessObjectProperty(Class boClass, Map<String, String> fieldValues) Deprecated.Checks whether any of the fieldValues being passed refer to a property within an ExternalizableBusinessObject.protected booleanisExternalBusinessObjectProperty(Object sampleBo, String propertyName) Deprecated.Check whether the given property represents a property within an EBO starting with the sampleBo object given.booleanDeprecated.This method returns whether the previously executed getSearchResults used the primary key values to search, ignoring all non key valuesremoveExternalizableBusinessObjectFieldValues(Class boClass, Map<String, String> fieldValues) Deprecated.Returns a map stripped of any properties which refer to ExternalizableBusinessObjects.Methods inherited from class org.kuali.rice.kns.lookup.AbstractLookupableHelperServiceImpl
addToReturnHref, allowsMaintenanceDeleteAction, allowsMaintenanceEditAction, allowsMaintenanceNewOrCopyAction, allowsNewOrCopyAction, applyConditionalLogicForFieldDisplay, applyFieldAuthorizationsFromNestedLookups, checkForAdditionalFields, getActionUrlHref, 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, getPropertyClass, getReadOnlyFieldsList, getReferencesToRefresh, getReturnAnchorHtmlData, getReturnHref, getReturnHref, getReturnInputHtmlData, getReturnKeys, getReturnLocation, getReturnUrl, getReturnUrl, getRows, getSearchResultsActualSizeKnown, getSequenceAccessorService, getSupplementalMenuBar, getTitle, getUrlData, getUrlData, isResultReturnable, maskValueIfNecessary, performClear, performCustomAction, performLookup, 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
-
Field Details
-
LOG
protected static final org.apache.logging.log4j.Logger LOGDeprecated. -
searchUsingOnlyPrimaryKeyValues
protected boolean searchUsingOnlyPrimaryKeyValuesDeprecated.
-
-
Constructor Details
-
KualiLookupableHelperServiceImpl
public KualiLookupableHelperServiceImpl()Deprecated.
-
-
Method Details
-
getSearchResults
public List<? extends org.kuali.rice.krad.bo.BusinessObject> getSearchResults(Map<String, String> fieldValues) Deprecated.Uses Lookup Service to provide a basic search.- Specified by:
getSearchResultsin interfaceLookupableHelperService- Specified by:
getSearchResultsin classAbstractLookupableHelperServiceImpl- Parameters:
fieldValues- - Map containing prop name keys and search values- Returns:
- List found business objects
- See Also:
-
getSearchResultsUnbounded
public List<? extends org.kuali.rice.krad.bo.BusinessObject> getSearchResultsUnbounded(Map<String, String> fieldValues) Deprecated.Uses Lookup Service to provide a basic unbounded search.- Specified by:
getSearchResultsUnboundedin interfaceLookupableHelperService- Overrides:
getSearchResultsUnboundedin classAbstractLookupableHelperServiceImpl- Parameters:
fieldValues- - Map containing prop name keys and search values- Returns:
- List found business objects
- See Also:
-
isExternalBusinessObjectProperty
Deprecated.Check whether the given property represents a property within an EBO starting with the sampleBo object given. This is used to determine if a criteria needs to be applied to the EBO first, before sending to the normal lookup DAO. -
getExternalBusinessObjectProperty
Deprecated.Get the name of the property which represents the ExternalizableBusinessObject for the given property. This method can not handle nested properties within the EBO. Returns null if the property is not a nested property or is part of an add line. -
hasExternalBusinessObjectProperty
Deprecated.Checks whether any of the fieldValues being passed refer to a property within an ExternalizableBusinessObject. -
removeExternalizableBusinessObjectFieldValues
protected Map<String,String> removeExternalizableBusinessObjectFieldValues(Class boClass, Map<String, String> fieldValues) Deprecated.Returns a map stripped of any properties which refer to ExternalizableBusinessObjects. These values may not be passed into the lookup service, since the objects they refer to are not in the local database. -
getExternalizableBusinessObjectFieldValues
protected Map<String,String> getExternalizableBusinessObjectFieldValues(String eboPropertyName, Map<String, String> fieldValues) Deprecated.Return the EBO fieldValue entries explicitly for the given eboPropertyName. (I.e., any properties with the given property name as a prefix. -
getExternalizableBusinessObjectProperties
protected List<String> getExternalizableBusinessObjectProperties(Class boClass, Map<String, String> fieldValues) Deprecated.Get the complete list of all properties referenced in the fieldValues that are ExternalizableBusinessObjects. This is a list of the EBO object references themselves, not of the properties within them. -
getExternalizableBusinessObjectClass
protected Class<? extends org.kuali.rice.krad.bo.ExternalizableBusinessObject> getExternalizableBusinessObjectClass(Class boClass, String propertyName) Deprecated.Given an property on the main BO class, return the defined type of the ExternalizableBusinessObject. This will be used by other code to determine the correct module service to call for the lookup.- Parameters:
boClass-propertyName-- Returns:
-
getSearchResultsHelper
protected List<? extends org.kuali.rice.krad.bo.BusinessObject> getSearchResultsHelper(Map<String, String> fieldValues, boolean unbounded) Deprecated.This method does the actual search, with the parameters specified, and returns the result. NOTE that it will not do any upper-casing based on the DD forceUppercase. That is handled through an external call to LookupUtils.forceUppercase().- Parameters:
fieldValues- A Map of the fieldNames and fieldValues to be searched on.unbounded- Whether the results should be bounded or not to a certain max size.- Returns:
- A List of search results.
-
isSearchUsingOnlyPrimaryKeyValues
public boolean isSearchUsingOnlyPrimaryKeyValues()Deprecated.Description copied from interface:LookupableHelperServiceThis method returns whether the previously executed getSearchResults used the primary key values to search, ignoring all non key values- Specified by:
isSearchUsingOnlyPrimaryKeyValuesin interfaceLookupableHelperService- Overrides:
isSearchUsingOnlyPrimaryKeyValuesin classAbstractLookupableHelperServiceImpl- Returns:
- false always, subclasses should override to do something smarter
- See Also:
-
getPrimaryKeyFieldLabels
Deprecated.Returns a comma delimited list of primary key field labels, to be used on the UI to tell the user which fields were used to search These labels are generated from the DD definitions for the lookup fields- Specified by:
getPrimaryKeyFieldLabelsin interfaceLookupableHelperService- Overrides:
getPrimaryKeyFieldLabelsin classAbstractLookupableHelperServiceImpl- Returns:
- a comma separated list of field attribute names. If no fields found, returns "N/A"
- See Also:
-
LookupableImpl.