org.kuali.rice.kns.uif.service
Interface LookupViewHelperService

All Superinterfaces:

ViewHelperService

All Known Implementing Classes:

FiscalOfficerInfoLookupViewHelperServiceImpl, LookupViewHelperServiceImpl

public interface LookupViewHelperService
extends ViewHelperService

A ViewHelperService that is specifically used for Lookups

Author:

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

Method Summary

String	getActionUrlsFromField(GeneratedField generatedField) Builds the HTML string text needed to perform maintenance actions for the data object represented by the current row in the list.
Set<String>	getConditionallyHiddenPropertyNames()
Set<String>	getConditionallyReadOnlyPropertyNames()
Set<String>	getConditionallyRequiredPropertyNames()
String	getCreateNewUrl(GeneratedField generatedField) Builds the HTML string text needed to create a new document for the class represented by this lookup view.
List<String>	getReadOnlyFieldsList() Gets the readOnlyFieldsList attribute.
String	getReturnFormKey()
String	getReturnLocation()
String	getReturnUrlForResults(GeneratedField generatedField) Build the HTML string text needed to return the object represented by the current row in the list to the source object that called the Lookup.
boolean	isAtLeastOneRowHasActions()
boolean	isAtLeastOneRowReturnable()
Map<String,String>	performClear(Map<String,String> fieldsForLookup) This method allows for customization of the lookup clear
Collection<?>	performSearch(Map<String,String> criteriaFieldsForLookup, boolean bounded) This method ...
void	setDataObjectClass(Class<?> dataObjectClass)
void	setDocNum(String docNum)
void	setFieldConversions(Map<String,String> fieldConversions)
void	setReadOnlyFieldsList(List<String> readOnlyFieldsList) Sets the readOnlyFieldsList attribute value.
void	validateSearchParameters(List<? extends Component> criteriaComponents, Map<String,String> fieldValues) Validates the values filled in as search criteria, also checks for required field values.

Methods inherited from interface org.kuali.rice.kns.uif.service.ViewHelperService

applyDefaultValues, applyDefaultValuesForCollectionLine, buildInquiryLink, performApplyModel, performComponentInitialization, performComponentLifecycle, performFinalize, performInitialization, populateViewFromRequestParameters, processCollectionAddLine, processCollectionDeleteLine

Method Detail

performSearch

Collection<?> performSearch(Map<String,String> criteriaFieldsForLookup,
                            boolean bounded)

This method ...

Parameters:

criteriaFieldsForLookup -

bounded -

Returns:

the list of result BOs, possibly bounded

performClear

Map<String,String> performClear(Map<String,String> fieldsForLookup)

This method allows for customization of the lookup clear

validateSearchParameters

void validateSearchParameters(List<? extends Component> criteriaComponents,
                              Map<String,String> fieldValues)

Validates the values filled in as search criteria, also checks for required field values.

Parameters:

criteriaComponents - - Components that are a part of the criteria for the lookup

fieldValues - - Map of property/value pairs

getReadOnlyFieldsList

List<String> getReadOnlyFieldsList()

Gets the readOnlyFieldsList attribute.

Returns:

Returns the readOnlyFieldsList.

setReadOnlyFieldsList

void setReadOnlyFieldsList(List<String> readOnlyFieldsList)

Sets the readOnlyFieldsList attribute value.

Parameters:

readOnlyFieldsList - The readOnlyFieldsList to set.

setDataObjectClass

void setDataObjectClass(Class<?> dataObjectClass)

setFieldConversions

void setFieldConversions(Map<String,String> fieldConversions)

setDocNum

void setDocNum(String docNum)

getReturnLocation

String getReturnLocation()

getReturnFormKey

String getReturnFormKey()

isAtLeastOneRowReturnable

boolean isAtLeastOneRowReturnable()

isAtLeastOneRowHasActions

boolean isAtLeastOneRowHasActions()

getCreateNewUrl

String getCreateNewUrl(GeneratedField generatedField)

Builds the HTML string text needed to create a new document for the class represented by this lookup view. By default this includes verifying that the current user has permission to

Parameters:

generatedField - - the field that will be used to display the String text

Returns:

String representing both the url and the HTML text required for the page

getActionUrlsFromField

String getActionUrlsFromField(GeneratedField generatedField)

Builds the HTML string text needed to perform maintenance actions for the data object represented by the current row in the list. By default this includes checking permissions for which maintenance actions the user is allowed to perform.

Parameters:

generatedField - - the field that will be used to display the String text

Returns:

String representing the HTML text required for any maintenance actions the user is allowed to perform

getReturnUrlForResults

String getReturnUrlForResults(GeneratedField generatedField)

Build the HTML string text needed to return the object represented by the current row in the list to the source object that called the Lookup.

Parameters:

generatedField -

Returns:

getConditionallyReadOnlyPropertyNames

Set<String> getConditionallyReadOnlyPropertyNames()

Returns:

Set of property names that should be set as read only based on the current search contents

getConditionallyRequiredPropertyNames

Set<String> getConditionallyRequiredPropertyNames()

Returns:

Set of property names that should be set as required based on the current search contents

getConditionallyHiddenPropertyNames

Set<String> getConditionallyHiddenPropertyNames()

Returns:

Set of property names that should be set as hidden based on the current search contents