org.kuali.rice.krad.lookup

Interface Lookupable

All Superinterfaces:

Serializable, ViewHelperService

All Known Implementing Classes:

AgendaLookupableHelperServiceImpl, GroupLookupableImpl, LabsTravelAccountLookupableImpl, LookupableImpl, PersonLookupableImpl, PropositionLookupableHelperServiceImpl, QuickfinderViewHelperServiceImpl, TravelLookupableImpl, TravelLookupableImpl, UIRoleMemberLookupableImpl

public interface Lookupable
extends ViewHelperService, Serializable

Provides contract for implementing a lookup within the lookup framework.

Author:

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	allowsMaintenanceDeleteAction(Object dataObject) Determines if given data object has associated maintenance document that allows delete maintenance actions.
boolean	allowsMaintenanceEditAction(Object dataObject) Determines if given data object has associated maintenance document that allows edit maintenance actions.
boolean	allowsMaintenanceNewOrCopyAction() Determines if given data object has associated maintenance document that allows new or copy maintenance actions.
void	buildMaintenanceActionLink(Link actionLink, Object model, String maintenanceMethodToCall) Invoked to build a maintenance URL for a result row.
void	buildMultiValueSelectField(InputField selectField, Object model) Set the value for the input field control to contain the field conversion values for the line.
void	buildReturnUrlForResult(Link returnLink, Object model) Invoked to build the return URL for a result row.
Class<?>	getDataObjectClass() Returns the class for the data object the lookup is configured with.
Map<String,String>	performClear(LookupForm form, Map<String,String> searchCriteria) Invoked when the clear action is requested to reset the search fields to their initial default values.
Collection<?>	performSearch(LookupForm form, Map<String,String> searchCriteria, boolean bounded) Invoked to carry out the lookup search based on the given map of key/value search values.
void	setDataObjectClass(Class<?> dataObjectClass) Sets the class for the data object the lookup will be provided on.

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

addCustomContainerComponents, applyDefaultValues, applyDefaultValuesForCollectionLine, buildGrowlScript, buildInquiryLink, getDefaultValueForField, getExpressionEvaluatorFactory, performCustomApplyModel, performCustomFinalize, performCustomInitialization, performCustomViewFinalize, performCustomViewInitialization, populateDefaultValueForField, populateViewFromRequestParameters, processAfterAddLine, processAfterDeleteLine, processAfterEditLine, processAfterSaveLine, processAndAddLineObject, processBeforeAddLine, processBeforeEditLine, processBeforeSaveLine, processCollectionAddBlankLine, processCollectionAddLine, processCollectionCloseEditLineDialog, processCollectionDeleteLine, processCollectionEditLine, processCollectionRetrieveEditLineDialog, processCollectionSaveLine, processMultipleValueLookupResults, refreshReference, refreshReferences, retrieveEditModesAndActionFlags, setElementContext, setViewContext

Method Detail

performSearch

Collection<?> performSearch(LookupForm form,
                          Map<String,String> searchCriteria,
                          boolean bounded)

Invoked to carry out the lookup search based on the given map of key/value search values.

Parameters:

form - lookup form instance containing the lookup data

searchCriteria - map of criteria currently set

bounded - indicates whether the results should be limited (if necessary) to the max search result limit configured

Returns:

the list of result objects, possibly bounded with CollectionIncomplete

performClear

Map<String,String> performClear(LookupForm form,
                              Map<String,String> searchCriteria)

Invoked when the clear action is requested to reset the search fields to their initial default values.

Parameters:

form - lookup form instance containing the lookup data

searchCriteria - map of criteria currently set

Returns:

map of criteria with field values reset to defaults

getDataObjectClass

Class<?> getDataObjectClass()

Returns the class for the data object the lookup is configured with.

Returns:

Class data object class

setDataObjectClass

void setDataObjectClass(Class<?> dataObjectClass)

Sets the class for the data object the lookup will be provided on.

Parameters:

dataObjectClass - - data object class for lookup

buildReturnUrlForResult

void buildReturnUrlForResult(Link returnLink,
                           Object model)

Invoked to build the return URL for a result row.

Based on the line contained in the field context, the URL for returning the role is constructed and set as the href for the link. If a return link cannot be constructed the link should be set to not render

Parameters:

returnLink - link that will be used to render the return URL

model - lookup form containing the data

buildMaintenanceActionLink

void buildMaintenanceActionLink(Link actionLink,
                              Object model,
                              String maintenanceMethodToCall)

Invoked to build a maintenance URL for a result row.

Based on the line contained in the field context and the given maintenance method that should be called a URL is constructed and set as the action on the action link. If a maintenance link cannot be constructed the action link should be set to not render

Parameters:

actionLink - link that will be used to return the maintenance URL

model - lookup form containing the data

maintenanceMethodToCall - name of the method that should be invoked in the maintenance controller

buildMultiValueSelectField

void buildMultiValueSelectField(InputField selectField,
                              Object model)

Set the value for the input field control to contain the field conversion values for the line.

Creates and populate the value of the input field control. This value is built according to LookupForm.getFieldConversions() and allows for client side population of the returned fields without having to do an additional server call.

Parameters:

selectField - the InputField used to mark the lookup row as selected

model - lookup form containing the model data

allowsMaintenanceNewOrCopyAction

boolean allowsMaintenanceNewOrCopyAction()

Determines if given data object has associated maintenance document that allows new or copy maintenance actions.

Returns:

boolean true if the maintenance new or copy action is allowed for the data object instance, false otherwise

allowsMaintenanceEditAction

boolean allowsMaintenanceEditAction(Object dataObject)

Determines if given data object has associated maintenance document that allows edit maintenance actions.

Parameters:

dataObject - data object

Returns:

boolean true if the maintenance edit action is allowed for the data object instance, false otherwise

allowsMaintenanceDeleteAction

boolean allowsMaintenanceDeleteAction(Object dataObject)

Determines if given data object has associated maintenance document that allows delete maintenance actions.

Parameters:

dataObject - data object

Returns:

boolean true if the maintenance delete action is allowed for the data object instance, false otherwise