org.kuali.rice.krad.web.controller
Class LookupController

java.lang.Object
  org.kuali.rice.krad.web.controller.UifControllerBase
      org.kuali.rice.krad.web.controller.LookupController

@Controller
@RequestMapping(value="/lookup")
public class LookupController
extends UifControllerBase

Controller that handles requests coming from a LookupView

Author:

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

Constructor Summary

LookupController()

Method Summary

org.springframework.web.servlet.ModelAndView	cancel(UifFormBase form, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Just returns as if return with no value was selected
org.springframework.web.servlet.ModelAndView	clearValues(LookupForm lookupForm, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) clearValues - clears the values of all the fields on the jsp.
protected LookupForm	createInitialForm(javax.servlet.http.HttpServletRequest request) Called to create a new model(form) object when necessary.
org.springframework.web.servlet.ModelAndView	returnSelected(LookupForm lookupForm, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Invoked from the UI to return the selected lookup results lines, parameters are collected to build a URL to the caller and then a redirect is performed
org.springframework.web.servlet.ModelAndView	search(LookupForm lookupForm, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) search - sets the values of the data entered on the form on the jsp into a map and then searches for the results.
org.springframework.web.servlet.ModelAndView	start(UifFormBase form, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Invoked to request an lookup view for a data object class
protected void	suppressActionsIfNeeded(LookupForm lookupForm)

Methods inherited from class org.kuali.rice.krad.web.controller.UifControllerBase

addBlankLine, addLine, checkForm, checkViewAuthorization, close, deleteLine, getBooleanDialogResponse, getMessageView, getStringDialogResponse, getUIFModelAndView, getUIFModelAndView, getViewService, hasDialogBeenAnswered, hasDialogBeenDisplayed, initForm, navigate, performFieldQuery, performFieldSuggest, performLookup, performRedirect, refresh, returnFromLightbox, returnToHistory, returnToHub, returnToPrevious, saveLine, showDialog, toggleInactiveRecordDisplay

Methods inherited from class java.lang.Object

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

Constructor Detail

LookupController

public LookupController()

Method Detail

createInitialForm

protected LookupForm createInitialForm(javax.servlet.http.HttpServletRequest request)

Description copied from class: UifControllerBase

Called to create a new model(form) object when necessary. This usually occurs on the initial request in a conversation (when the model is not present in the session). This method must be overridden when extending a controller and using a different form type than the superclass.

Specified by:

createInitialForm in class UifControllerBase

Parameters:

request - - the http request that was made

See Also:

UifControllerBase.createInitialForm(javax.servlet.http.HttpServletRequest)

suppressActionsIfNeeded

protected void suppressActionsIfNeeded(LookupForm lookupForm)

start

@RequestMapping(params="methodToCall=start")
public org.springframework.web.servlet.ModelAndView start(@ModelAttribute(value="KualiForm")
                                                                         UifFormBase form,
                                                                         org.springframework.validation.BindingResult result,
                                                                         javax.servlet.http.HttpServletRequest request,
                                                                         javax.servlet.http.HttpServletResponse response)

Invoked to request an lookup view for a data object class

Checks if the data object is externalizable and we need to redirect to the appropriate lookup URL, else continues with the lookup view display

Overrides:

start in class UifControllerBase

cancel

@RequestMapping(method=POST,
                params="methodToCall=cancel")
public org.springframework.web.servlet.ModelAndView cancel(@ModelAttribute(value="KualiForm")
                                                                          UifFormBase form,
                                                                          org.springframework.validation.BindingResult result,
                                                                          javax.servlet.http.HttpServletRequest request,
                                                                          javax.servlet.http.HttpServletResponse response)

Just returns as if return with no value was selected

Overrides:

cancel in class UifControllerBase

clearValues

@RequestMapping(method=POST,
                params="methodToCall=clearValues")
public org.springframework.web.servlet.ModelAndView clearValues(@ModelAttribute(value="KualiForm")
                                                                               LookupForm lookupForm,
                                                                               org.springframework.validation.BindingResult result,
                                                                               javax.servlet.http.HttpServletRequest request,
                                                                               javax.servlet.http.HttpServletResponse response)

clearValues - clears the values of all the fields on the jsp.

search

@RequestMapping(params="methodToCall=search")
public org.springframework.web.servlet.ModelAndView search(@ModelAttribute(value="KualiForm")
                                                                          LookupForm lookupForm,
                                                                          org.springframework.validation.BindingResult result,
                                                                          javax.servlet.http.HttpServletRequest request,
                                                                          javax.servlet.http.HttpServletResponse response)

search - sets the values of the data entered on the form on the jsp into a map and then searches for the results.

returnSelected

@RequestMapping(method=POST,
                params="methodToCall=returnSelected")
public org.springframework.web.servlet.ModelAndView returnSelected(@ModelAttribute(value="KualiForm")
                                                                                  LookupForm lookupForm,
                                                                                  org.springframework.validation.BindingResult result,
                                                                                  javax.servlet.http.HttpServletRequest request,
                                                                                  javax.servlet.http.HttpServletResponse response)

Invoked from the UI to return the selected lookup results lines, parameters are collected to build a URL to the caller and then a redirect is performed

Parameters:

lookupForm - - lookup form instance containing the selected results and lookup configuration