org.kuali.rice.krad.lookup
Class LookupController

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

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

Controller that handles requests for 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) Cancels the lookup request and returns with no value selected.
org.springframework.web.servlet.ModelAndView	clearValues(LookupForm lookupForm) Resets values in the lookup criteria group to their initial default values.
protected LookupForm	createInitialForm(javax.servlet.http.HttpServletRequest request) Called to create a new model(form) object when necessary.
org.springframework.web.servlet.ModelAndView	deselectAllPages(LookupForm lookupForm, javax.servlet.http.HttpServletRequest request, org.springframework.web.servlet.mvc.support.RedirectAttributes redirectAttributes) Invoked from the UI to mark values from all pages as deselected.
org.springframework.web.servlet.ModelAndView	retrieveCollectionPage(UifFormBase form, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Retrieve a page defined by the page number parameter for a collection group.
String	returnSelected(LookupForm lookupForm, javax.servlet.http.HttpServletRequest request, org.springframework.web.servlet.mvc.support.RedirectAttributes redirectAttributes) 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) Performs the search action using the given lookup criteria and sets the results onto the lookup form, then renders the same lookup view.
org.springframework.web.servlet.ModelAndView	selectAllPages(LookupForm lookupForm, javax.servlet.http.HttpServletRequest request, org.springframework.web.servlet.mvc.support.RedirectAttributes redirectAttributes) Invoked from the UI to mark values from all pages as selected.
org.springframework.web.servlet.ModelAndView	start(UifFormBase form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Invoked to render an lookup view for a data object class.
org.springframework.web.servlet.ModelAndView	tableJsonRetrieval(UifFormBase form, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Get method for getting aaData for jquery datatables which are using sAjaxSource option.

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

addBlankLine, addLine, back, checkForm, checkViewAuthorization, defaultMapping, deleteLine, getBooleanDialogResponse, getMessageView, getStringDialogResponse, getUIFModelAndView, getUIFModelAndView, getUIFModelAndView, getUIFModelAndViewWithInit, getViewService, hasDialogBeenAnswered, hasDialogBeenDisplayed, initForm, navigate, performFieldQuery, performFieldSuggest, performLookup, performRedirect, performRedirect, refresh, resetDialogStatus, returnFromLightbox, returnToHistory, returnToHub, returnToPrevious, saveLine, sessionTimeout, showDialog

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)

start

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

Invoked to render 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

search

@MethodAccessible
@RequestMapping(params="methodToCall=search")
public org.springframework.web.servlet.ModelAndView search(@ModelAttribute(value="KualiForm")
                                                                                           LookupForm lookupForm)

Performs the search action using the given lookup criteria and sets the results onto the lookup form, then renders the same lookup view.

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)

Cancels the lookup request and returns with no value 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)

Resets values in the lookup criteria group to their initial default values.

selectAllPages

@MethodAccessible
@RequestMapping(method=POST,
                params="methodToCall=selectAllPages")
public org.springframework.web.servlet.ModelAndView selectAllPages(@ModelAttribute(value="KualiForm")
                                                                                                   LookupForm lookupForm,
                                                                                                   javax.servlet.http.HttpServletRequest request,
                                                                                                   org.springframework.web.servlet.mvc.support.RedirectAttributes redirectAttributes)

Invoked from the UI to mark values from all pages as selected. Copies the value from the lookupResults to selectedLookupResultsCache

Parameters:

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

request - servlet request

redirectAttributes - redirect attributes instance

Returns:

ModelAndView

deselectAllPages

@MethodAccessible
@RequestMapping(method=POST,
                params="methodToCall=deselectAllPages")
public org.springframework.web.servlet.ModelAndView deselectAllPages(@ModelAttribute(value="KualiForm")
                                                                                                     LookupForm lookupForm,
                                                                                                     javax.servlet.http.HttpServletRequest request,
                                                                                                     org.springframework.web.servlet.mvc.support.RedirectAttributes redirectAttributes)

Invoked from the UI to mark values from all pages as deselected. Clears the selectedLookupResultsCache

Parameters:

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

request - servlet request

redirectAttributes - redirect attributes instance

Returns:

ModelAndView

retrieveCollectionPage

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

Retrieve a page defined by the page number parameter for a collection group.

Overrides:

retrieveCollectionPage in class UifControllerBase

Throws:

Exception

tableJsonRetrieval

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

Get method for getting aaData for jquery datatables which are using sAjaxSource option.

This will render the aaData JSON for the displayed page of the table matching the tableId passed in the request parameters.

Overrides:

tableJsonRetrieval in class UifControllerBase

returnSelected

@RequestMapping(method=POST,
                params="methodToCall=returnSelected")
public String returnSelected(@ModelAttribute(value="KualiForm")
                                            LookupForm lookupForm,
                                            javax.servlet.http.HttpServletRequest request,
                                            org.springframework.web.servlet.mvc.support.RedirectAttributes redirectAttributes)

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

request - servlet request

redirectAttributes - redirect attributes instance

Returns:

redirect URL for the return location