org.kuali.rice.krad.web.service.impl

Class NavigationControllerServiceImpl

java.lang.Object

org.kuali.rice.krad.web.service.impl.NavigationControllerServiceImpl

All Implemented Interfaces:

NavigationControllerService

public class NavigationControllerServiceImpl
extends Object
implements NavigationControllerService

Default implementation of the navigation controller service.

Author:

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

Constructor Summary

Constructors

Constructor and Description
NavigationControllerServiceImpl()

Method Summary

Modifier and Type	Method and 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.
protected ModelAndViewService	getModelAndViewService()
protected String	getReturnUrl(UifFormBase form, boolean returnToPrevious, boolean returnToApplicationHome, boolean returnToFlowStart) Gets the URL to return to based form data and the given flags.
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.
void	setModelAndViewService(ModelAndViewService modelAndViewService)

Methods inherited from class java.lang.Object

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

Constructor Detail

NavigationControllerServiceImpl

public NavigationControllerServiceImpl()

Method Detail

back

public 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.

Specified by:

back in interface NavigationControllerService

Parameters:

form - form instance containing the model data

Returns:

ModelAndView instance for rendering the view

returnToPrevious

public org.springframework.web.servlet.ModelAndView returnToPrevious(UifFormBase form)

Invoked to navigate back one page in the user's history.

Specified by:

returnToPrevious in interface NavigationControllerService

Parameters:

form - form instance containing the model data

Returns:

ModelAndView instance for rendering the view

returnToHub

public org.springframework.web.servlet.ModelAndView returnToHub(UifFormBase form)

Invoked to navigate back to the first page in the user's history.

Specified by:

returnToHub in interface NavigationControllerService

Parameters:

form - form instance containing the model data

Returns:

ModelAndView instance for rendering the view

returnToHistory

public 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.

Specified by:

returnToHistory in interface NavigationControllerService

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

getReturnUrl

protected String getReturnUrl(UifFormBase form,
                              boolean returnToPrevious,
                              boolean returnToApplicationHome,
                              boolean returnToFlowStart)

Gets the URL to return to based form data and the given flags.

Parameters:

form - form instance containing return location (possibly) and history manager

returnToPrevious - whether we should return to the previous view

returnToApplicationHome - whether we should return to the configured application home

returnToFlowStart - when in a flow, whether to return to the flow start point

Returns:

String URL

navigate

public org.springframework.web.servlet.ModelAndView navigate(UifFormBase form)

Invoked to navigate to a new page within the view.

Specified by:

navigate in interface NavigationControllerService

Parameters:

form - form instance containing the model data

Returns:

ModelAndView instance for rendering the view

getModelAndViewService

protected ModelAndViewService getModelAndViewService()

setModelAndViewService

public void setModelAndViewService(ModelAndViewService modelAndViewService)