org.kuali.rice.kew.bo.lookup
Class DocSearchCriteriaDTOLookupableHelperServiceImpl

java.lang.Object
  org.kuali.rice.kns.lookup.AbstractLookupableHelperServiceImpl
      org.kuali.rice.kns.lookup.KualiLookupableHelperServiceImpl
          org.kuali.rice.kew.bo.lookup.DocSearchCriteriaDTOLookupableHelperServiceImpl

All Implemented Interfaces:

Serializable, LookupableHelperService

public class DocSearchCriteriaDTOLookupableHelperServiceImpl
extends KualiLookupableHelperServiceImpl

Lookupable helper class for new doc search

Author:

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

See Also:

Serialized Form

Field Summary

(package private) DateTimeService	dateTimeService
private static Pattern	HREF_PATTERN
(package private) DocumentLookupCriteriaProcessor	processor
(package private) boolean	savedSearch
private static long	serialVersionUID

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

Constructor Summary

DocSearchCriteriaDTOLookupableHelperServiceImpl()

Method Summary

boolean	checkForAdditionalFields(Map fieldValues) This implementation always returns false.
private Object	getDocSearchCriteriaDTOFieldValue(DocSearchCriteriaDTO searchCriteria, String fieldName)
Field	getExtraField() get an extra field
private List<Field>	getFields(List<Row> rows)
HtmlData	getInquiryUrl(BusinessObject bo, String propertyName) Returns the inquiry url for a field if one exist.
private Object	getSearchableAttributeFieldValue(DocSearchCriteriaDTO searchCriteria, String fieldName)
String	getSupplementalMenuBar() This method gets the supplemental lookup menu if any
private static DocumentType	getValidDocumentType(String docTypeName) retrieve a document type.
void	performClear(LookupForm lookupForm) This method does the logic for the clear action.
boolean	performCustomAction(boolean ignoreErrors) performs custom actions.
Collection	performLookup(LookupForm lookupForm, Collection resultTable, boolean bounded) Performs the lookup and returns a collection of lookup items
void	setDateTimeService(DateTimeService dateTimeService)
protected void	setRows() Constructs the list of rows for the search fields.
protected void	setRows(Map fieldValues, String docTypeName)
private void	setRowsAfterClear(DocSearchCriteriaDTO searchCriteria, Map<String,String[]> fieldValues)
boolean	shouldDisplayHeaderNonMaintActions()
boolean	shouldDisplayLookupCriteria()
void	validateSearchParameters(Map fieldValues) Checks that any required search fields have value.

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

getExternalBusinessObjectProperty, getExternalizableBusinessObjectClass, getExternalizableBusinessObjectFieldValues, getExternalizableBusinessObjectProperties, getPrimaryKeyFieldLabels, getSearchResults, 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, getColumns, getConditionallyHiddenPropertyNames, getConditionallyReadOnlyPropertyNames, getConditionallyRequiredPropertyNames, getCurrentSearchFieldValue, getCustomActionUrls, getDataDictionaryService, getDefaultSortColumns, getDocFormKey, getDocNum, getEmptyActionUrls, getEmptyAnchorHtmlData, getEncryptionService, getKualiConfigurationService, getKualiInquirable, getLookupResultsService, getLookupService, getMaintenanceDocumentDictionaryService, getMaintenanceDocumentTypeName, getMaintenanceUrl, getParameters, getParameters, getParameterService, getParametersFromPrimaryKey, getPersistenceStructureService, getPropertyClass, getReadOnlyFieldsList, getReferencesToRefresh, getReturnAnchorHtmlData, getReturnHref, getReturnHref, getReturnInputHtmlData, getReturnKeys, getReturnLocation, getReturnUrl, getReturnUrl, getRows, getSequenceAccessorService, getTitle, getUrlData, getUrlData, isResultReturnable, maskValueIfNecessary, preprocessDateFields, setBackLocation, setBusinessObjectClass, setBusinessObjectDictionaryService, setBusinessObjectMetaDataService, setBusinessObjectService, setDataDictionaryService, setDocFormKey, setDocNum, setEncryptionService, setFieldConversions, setKualiInquirable, setLookupResultsService, setLookupService, setMaintenanceDocumentDictionaryService, setParameters, setParameterService, setParameterService, setPersistenceStructureService, setReadOnlyFieldsList, setReferencesToRefresh, setSequenceAccessorService, 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

dateTimeService

DateTimeService dateTimeService

processor

DocumentLookupCriteriaProcessor processor

savedSearch

boolean savedSearch

HREF_PATTERN

private static final Pattern HREF_PATTERN

Constructor Detail

DocSearchCriteriaDTOLookupableHelperServiceImpl

public DocSearchCriteriaDTOLookupableHelperServiceImpl()

Method Detail

setDateTimeService

public void setDateTimeService(DateTimeService dateTimeService)

See Also:

org.kuali.rice.kew.bo.lookup.DocumentRouteHeaderValueLookupableHelperService#setDateTimeService(org.kuali.rice.kns.service.DateTimeService)

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

See Also:

AbstractLookupableHelperServiceImpl.performLookup(org.kuali.rice.kns.web.struts.form.LookupForm, java.util.Collection, boolean)

getInquiryUrl

public HtmlData getInquiryUrl(BusinessObject bo,
                              String propertyName)

Description copied from class: AbstractLookupableHelperServiceImpl

Returns the inquiry url for a field if one exist.

Specified by:

getInquiryUrl in interface LookupableHelperService

Overrides:

getInquiryUrl in class AbstractLookupableHelperServiceImpl

Parameters:

bo - the business object instance to build the urls for

propertyName - the property which links to an inquirable

Returns:

String url to inquiry

See Also:

AbstractLookupableHelperServiceImpl.getInquiryUrl(org.kuali.rice.kns.bo.BusinessObject, java.lang.String)

setRows

protected void setRows()

Description copied from class: AbstractLookupableHelperServiceImpl

Constructs the list of rows for the search fields. All properties for the field objects come from the DataDictionary. To be called by setBusinessObject

Overrides:

setRows in class AbstractLookupableHelperServiceImpl

See Also:

AbstractLookupableHelperServiceImpl.setRows()

setRows

protected void setRows(Map fieldValues,
                       String docTypeName)

See Also:

AbstractLookupableHelperServiceImpl.setRows()

getFields

private List<Field> getFields(List<Row> rows)

setRowsAfterClear

private void setRowsAfterClear(DocSearchCriteriaDTO searchCriteria,
                               Map<String,String[]> fieldValues)

performClear

public void performClear(LookupForm lookupForm)

Description copied from class: AbstractLookupableHelperServiceImpl

This method does the logic for the clear action.

Specified by:

performClear in interface LookupableHelperService

Overrides:

performClear in class AbstractLookupableHelperServiceImpl

See Also:

org.kuali.rice.kns.lookup.AbstractLookupableHelperServiceImpl#performClear()

getValidDocumentType

private static DocumentType getValidDocumentType(String docTypeName)

retrieve a document type. This is not a case sensitive search so "TravelRequest" == "Travelrequest"

Parameters:

docTypeName -

Returns:

getSupplementalMenuBar

public String getSupplementalMenuBar()

Description copied from interface: LookupableHelperService

This method gets the supplemental lookup menu if any

Specified by:

getSupplementalMenuBar in interface LookupableHelperService

Overrides:

getSupplementalMenuBar in class AbstractLookupableHelperServiceImpl

Returns:

supplemental menu bar

See Also:

AbstractLookupableHelperServiceImpl.getSupplementalMenuBar()

shouldDisplayHeaderNonMaintActions

public boolean shouldDisplayHeaderNonMaintActions()

Specified by:

shouldDisplayHeaderNonMaintActions in interface LookupableHelperService

Overrides:

shouldDisplayHeaderNonMaintActions in class AbstractLookupableHelperServiceImpl

See Also:

AbstractLookupableHelperServiceImpl.shouldDisplayHeaderNonMaintActions()

shouldDisplayLookupCriteria

public boolean shouldDisplayLookupCriteria()

Specified by:

shouldDisplayLookupCriteria in interface LookupableHelperService

Overrides:

shouldDisplayLookupCriteria in class AbstractLookupableHelperServiceImpl

See Also:

AbstractLookupableHelperServiceImpl.shouldDisplayLookupCriteria()

checkForAdditionalFields

public boolean checkForAdditionalFields(Map 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:

AbstractLookupableHelperServiceImpl.checkForAdditionalFields(java.util.Map)

validateSearchParameters

public void validateSearchParameters(Map 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:

AbstractLookupableHelperServiceImpl.validateSearchParameters(java.util.Map)

performCustomAction

public boolean performCustomAction(boolean ignoreErrors)

Description copied from interface: LookupableHelperService

performs custom actions. return true to reperform search

Specified by:

performCustomAction in interface LookupableHelperService

Overrides:

performCustomAction in class AbstractLookupableHelperServiceImpl

Returns:

boolean to reperform search

See Also:

AbstractLookupableHelperServiceImpl.performCustomAction(boolean)

getExtraField

public Field getExtraField()

Description copied from interface: LookupableHelperService

get an extra field

Specified by:

getExtraField in interface LookupableHelperService

Overrides:

getExtraField in class AbstractLookupableHelperServiceImpl

Returns:

See Also:

AbstractLookupableHelperServiceImpl.getExtraField()

getDocSearchCriteriaDTOFieldValue

private Object getDocSearchCriteriaDTOFieldValue(DocSearchCriteriaDTO searchCriteria,
                                                 String fieldName)

getSearchableAttributeFieldValue

private Object getSearchableAttributeFieldValue(DocSearchCriteriaDTO searchCriteria,
                                                String fieldName)