Package org.kuali.rice.krad.lookup

Interface LookupControllerService

All Superinterfaces:
ControllerService
All Known Implementing Classes:
LookupControllerServiceImpl
public interface LookupControllerService extends ControllerService
Controller service that provides methods for supporting a lookup view.
Author:
Kuali Rice Team (rice.collab@kuali.org)

  • Method Summary

    Modifier and Type
    Method
    Description
    org.springframework.web.servlet.ModelAndView
    clearValues(LookupForm lookupForm)
    Performs a reset (or clear) on the lookup criteria values.
    org.springframework.web.servlet.ModelAndView
    deselectAllPages(LookupForm lookupForm)
    Handles the deselect all pages action on the lookup results.
    String
    returnSelected(LookupForm lookupForm, org.springframework.web.servlet.mvc.support.RedirectAttributes redirectAttributes)
    Invoked from the UI to return the selected lookup results lines back to the calling view.
    org.springframework.web.servlet.ModelAndView
    search(LookupForm lookupForm)
    Executes a search using the provided criteria and builds a list of results to return to the user.
    org.springframework.web.servlet.ModelAndView
    selectAllPages(LookupForm lookupForm)
    Handles the select all pages action on the lookup results.

    Methods inherited from interface org.kuali.rice.krad.web.service.ControllerService

    cancel, checkViewAuthorization, sessionTimeout, start

  • Method Details

    • search

      org.springframework.web.servlet.ModelAndView search(LookupForm lookupForm)
      Executes a search using the provided criteria and builds a list of results to return to the user.
      Parameters:
      lookupForm - form instance containing the lookup data
      Returns:
      ModelAndView instance for rendering the view

    • clearValues

      org.springframework.web.servlet.ModelAndView clearValues(LookupForm lookupForm)
      Performs a reset (or clear) on the lookup criteria values.
      Parameters:
      lookupForm - form instance containing the lookup data
      Returns:
      ModelAndView instance for rendering the view

    • selectAllPages

      org.springframework.web.servlet.ModelAndView selectAllPages(LookupForm lookupForm)
      Handles the select all pages action on the lookup results.
      Parameters:
      lookupForm - form instance containing the lookup data
      Returns:
      ModelAndView instance for rendering the view

    • deselectAllPages

      org.springframework.web.servlet.ModelAndView deselectAllPages(LookupForm lookupForm)
      Handles the deselect all pages action on the lookup results.
      Parameters:
      lookupForm - form instance containing the lookup data
      Returns:
      ModelAndView instance for rendering the view

    • returnSelected

      String returnSelected(LookupForm lookupForm, org.springframework.web.servlet.mvc.support.RedirectAttributes redirectAttributes)
      Invoked from the UI to return the selected lookup results lines back to the calling view.
      Parameters:
      lookupForm - form instance containing the lookup data
      redirectAttributes - spring provided redirect attributes
      Returns:
      String url for redirecting back to the lookup caller