Package org.kuali.rice.krad.web.service

Interface NavigationControllerService

All Known Implementing Classes:
NavigationControllerServiceImpl
public interface NavigationControllerService
Controller service that provides methods for navigating within the application and a view.
Author:
Kuali Rice Team (rice.collab@kuali.org)

  • Method Summary

    Modifier and Type
    Method
    Description
    org.springframework.web.servlet.ModelAndView
    back(UifFormBase form)
    Returns back to a previous URL by looking at various return mechanisms in HistoryFlow and on the form.
    org.springframework.web.servlet.ModelAndView
    navigate(UifFormBase form)
    Invoked to navigate to a new page within the view.
    org.springframework.web.servlet.ModelAndView
    returnToHistory(UifFormBase form, boolean returnToPrevious, boolean returnToApplicationHome, boolean returnToFlowStart)
    Invoked to navigate back to a point in the user's history.
    org.springframework.web.servlet.ModelAndView
    returnToHub(UifFormBase form)
    Invoked to navigate back to the first page in the user's history.
    org.springframework.web.servlet.ModelAndView
    returnToPrevious(UifFormBase form)
    Invoked to navigate back one page in the user's history.

  • Method Details

    • back

      org.springframework.web.servlet.ModelAndView back(UifFormBase form)
      Returns back to a previous URL by looking at various return mechanisms in HistoryFlow and on the form.

      Method supports the general back action component.

      Parameters:
      form - form instance containing the model data
      Returns:
      ModelAndView instance for rendering the view

    • returnToPrevious

      org.springframework.web.servlet.ModelAndView returnToPrevious(UifFormBase form)
      Invoked to navigate back one page in the user's history.
      Parameters:
      form - form instance containing the model data
      Returns:
      ModelAndView instance for rendering the view

    • returnToHub

      org.springframework.web.servlet.ModelAndView returnToHub(UifFormBase form)
      Invoked to navigate back to the first page in the user's history.
      Parameters:
      form - form instance containing the model data
      Returns:
      ModelAndView instance for rendering the view

    • returnToHistory

      org.springframework.web.servlet.ModelAndView returnToHistory(UifFormBase form, boolean returnToPrevious, boolean returnToApplicationHome, boolean returnToFlowStart)
      Invoked to navigate back to a point in the user's history.
      Parameters:
      form - form instance containing the model data
      returnToApplicationHome - indicates whether the user should be returned to the application home URL
      Returns:
      ModelAndView instance for rendering the view