001/**
002 * Copyright 2005-2018 The Kuali Foundation
003 *
004 * Licensed under the Educational Community License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.opensource.org/licenses/ecl2.php
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.kuali.rice.krad.web.service;
017
018import org.kuali.rice.krad.web.form.UifFormBase;
019import org.springframework.web.servlet.ModelAndView;
020
021/**
022 * Controller service that provides methods for navigating within the application and a view.
023 *
024 * @author Kuali Rice Team (rice.collab@kuali.org)
025 */
026public interface NavigationControllerService {
027
028    /**
029     * Returns back to a previous URL by looking at various return mechanisms in HistoryFlow and on the form.
030     *
031     * <p>Method supports the general back action component.</p>
032     *
033     * @param form form instance containing the model data
034     * @return ModelAndView instance for rendering the view
035     */
036    ModelAndView back(UifFormBase form);
037
038    /**
039     * Invoked to navigate back one page in the user's history.
040     *
041     * @param form form instance containing the model data
042     * @return ModelAndView instance for rendering the view
043     */
044    ModelAndView returnToPrevious(UifFormBase form);
045
046    /**
047     * Invoked to navigate back to the first page in the user's history.
048     *
049     * @param form form instance containing the model data
050     * @return ModelAndView instance for rendering the view
051     */
052    ModelAndView returnToHub(UifFormBase form);
053
054    /**
055     * Invoked to navigate back to a point in the user's history.
056     *
057     * @param form form instance containing the model data
058     * @param returnToApplicationHome indicates whether the user should be returned to the application home URL
059     * @return ModelAndView instance for rendering the view
060     */
061    ModelAndView returnToHistory(UifFormBase form, boolean returnToPrevious, boolean returnToApplicationHome,
062                boolean returnToFlowStart);
063
064    /**
065     * Invoked to navigate to a new page within the view.
066     *
067     * @param form form instance containing the model data
068     * @return ModelAndView instance for rendering the view
069     */
070    ModelAndView navigate(UifFormBase form);
071
072}