org.kuali.rice.kew.rule.bo

Class RuleBaseValuesLookupableHelperServiceImpl

java.lang.Object

org.kuali.rice.kns.lookup.AbstractLookupableHelperServiceImpl

org.kuali.rice.kns.lookup.KualiLookupableHelperServiceImpl

org.kuali.rice.kew.rule.bo.RuleBaseValuesLookupableHelperServiceImpl

All Implemented Interfaces:

Serializable, LookupableHelperService

public class RuleBaseValuesLookupableHelperServiceImpl
extends KualiLookupableHelperServiceImpl

This is a description of what this class does - jjhanso don't forget to fill this in.

Author:

Kuali Rice Team (rice.collab@kuali.org)

See Also:

Serialized Form

Field Summary

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

LOG, searchUsingOnlyPrimaryKeyValues

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, sequenceAccessorService, TITLE_ACTION_URL_PREPENDTEXT_PROPERTY, TITLE_RETURN_URL_PREPENDTEXT_PROPERTY

Constructor Summary

Constructors

Constructor and Description
RuleBaseValuesLookupableHelperServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkForAdditionalFields(Map<String,String> fieldValues) This implementation always returns false.
List<Column>	getColumns() Constructs the list of columns for the search results.
List<HtmlData>	getCustomActionUrls(BusinessObject businessObject, List pkNames) Child classes should override this method if they want to return some other action urls.
List<Row>	getRows() Returns a list of Row objects to be used to generate the search query screen Generally, setDataObjectClass needs to be called with a non-null value for proper operation
List<? extends BusinessObject>	getSearchResults(Map<String,String> fieldValues) Uses Lookup Service to provide a basic search.
Collection	performLookup(LookupForm lookupForm, Collection resultTable, boolean bounded) Performs the lookup and returns a collection of lookup items
void	validateSearchParameters(Map<String,String> fieldValues) Checks that any required search fields have value.

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

getExternalBusinessObjectProperty, getExternalizableBusinessObjectClass, getExternalizableBusinessObjectFieldValues, getExternalizableBusinessObjectProperties, getPrimaryKeyFieldLabels, getSearchResultsHelper, getSearchResultsUnbounded, hasExternalBusinessObjectProperty, isExternalBusinessObjectProperty, isSearchUsingOnlyPrimaryKeyValues, removeExternalizableBusinessObjectFieldValues

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

addToReturnHref, allowsMaintenanceDeleteAction, allowsMaintenanceEditAction, allowsMaintenanceNewOrCopyAction, allowsNewOrCopyAction, applyConditionalLogicForFieldDisplay, applyFieldAuthorizationsFromNestedLookups, getActionUrlHref, getActionUrls, getActionUrlTitleText, getBackLocation, getBusinessObjectAuthorizationService, getBusinessObjectClass, getBusinessObjectDictionaryService, getBusinessObjectMetaDataService, getBusinessObjectService, getColumnMaxLength, getConditionallyHiddenPropertyNames, getConditionallyReadOnlyPropertyNames, getConditionallyRequiredPropertyNames, getCurrentSearchFieldValue, 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, getSequenceAccessorService, getSupplementalMenuBar, getTitle, getUrlData, getUrlData, isResultReturnable, maskValueIfNecessary, performClear, performCustomAction, setBackLocation, setBusinessObjectClass, setBusinessObjectDictionaryService, setBusinessObjectMetaDataService, setBusinessObjectService, setDataDictionaryService, setDocFormKey, setDocNum, setEncryptionService, setFieldConversions, setKualiInquirable, setLookupResultsService, setLookupService, setMaintenanceDocumentDictionaryService, setParameters, setParameterService, setParameterService, setPersistenceStructureService, setReadOnlyFieldsList, setReferencesToRefresh, setRows, setSequenceAccessorService, shouldDisplayHeaderNonMaintActions, shouldDisplayLookupCriteria, validateSearchParameterWildcardAndOperators

Methods inherited from class java.lang.Object

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

Constructor Detail

RuleBaseValuesLookupableHelperServiceImpl

public RuleBaseValuesLookupableHelperServiceImpl()

Method Detail

getRows

public List<Row> getRows()

Description copied from interface: LookupableHelperService

Returns a list of Row objects to be used to generate the search query screen Generally, setDataObjectClass needs to be called with a non-null value for proper operation

Specified by:

getRows in interface LookupableHelperService

Overrides:

getRows in class AbstractLookupableHelperServiceImpl

Returns:

checkForAdditionalFields

public boolean checkForAdditionalFields(Map<String,String> fieldValues)

Description copied from class: AbstractLookupableHelperServiceImpl

This implementation always returns false.

Specified by:

checkForAdditionalFields in interface LookupableHelperService

Overrides:

checkForAdditionalFields in class AbstractLookupableHelperServiceImpl

Parameters:

fieldValues - - Map of property/value pairs

Returns:

boolean

See Also:

LookupableHelperService.checkForAdditionalFields(java.util.Map)

getSearchResults

public List<? extends BusinessObject> getSearchResults(Map<String,String> fieldValues)

Description copied from class: KualiLookupableHelperServiceImpl

Uses Lookup Service to provide a basic search.

Specified by:

getSearchResults in interface LookupableHelperService

Overrides:

getSearchResults in class KualiLookupableHelperServiceImpl

Parameters:

fieldValues - - Map containing prop name keys and search values

Returns:

List found business objects

See Also:

LookupableHelperService.getSearchResults(java.util.Map)

validateSearchParameters

public void validateSearchParameters(Map<String,String> fieldValues)

Description copied from class: AbstractLookupableHelperServiceImpl

Checks that any required search fields have value.

Specified by:

validateSearchParameters in interface LookupableHelperService

Overrides:

validateSearchParameters in class AbstractLookupableHelperServiceImpl

Parameters:

fieldValues - - Map of property/value pairs

See Also:

LookupableHelperService.validateSearchParameters(java.util.Map)

performLookup

public Collection performLookup(LookupForm lookupForm,
                       Collection resultTable,
                       boolean bounded)

Description copied from class: AbstractLookupableHelperServiceImpl

Performs the lookup and returns a collection of lookup items

Specified by:

performLookup in interface LookupableHelperService

Overrides:

performLookup in class AbstractLookupableHelperServiceImpl

Returns:

the list of result BOs, possibly bounded

getColumns

public List<Column> getColumns()

Description copied from class: AbstractLookupableHelperServiceImpl

Constructs the list of columns for the search results. All properties for the column objects come from the DataDictionary.

Specified by:

getColumns in interface LookupableHelperService

Overrides:

getColumns in class AbstractLookupableHelperServiceImpl

Returns:

List of Column objects used to render the result table

getCustomActionUrls

public List<HtmlData> getCustomActionUrls(BusinessObject businessObject,
                                 List pkNames)

Description copied from class: AbstractLookupableHelperServiceImpl

Child classes should override this method if they want to return some other action urls.

Specified by:

getCustomActionUrls in interface LookupableHelperService

Overrides:

getCustomActionUrls in class AbstractLookupableHelperServiceImpl

Returns:

See Also:

LookupableHelperService#getCustomActionUrls(org.kuali.rice.krad.bo.BusinessObject, java.util.List, java.util.List pkNames)