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 handles the refresh method.
023 *
024 * @author Kuali Rice Team (rice.collab@kuali.org)
025 */
026public interface RefreshControllerService {
027
028    /**
029     * Invoked when returning from another view.
030     *
031     * <p>Several places in the framework do a return from a view to another view. Examples are return from
032     * a lookup, breadcrumb navigation, and navigation methods provided by the controller. This is the default
033     * method invoked when returning to perform any additional functionality.</p>
034     *
035     * @param form form instance containing the model data
036     * @return ModelAndView instance for rendering the view
037     */
038    ModelAndView refresh(UifFormBase form);
039}