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.exception.AuthorizationException;
019import org.kuali.rice.krad.web.form.UifFormBase;
020import org.springframework.web.servlet.ModelAndView;
021
022/**
023 * Controller service that provides the basic entry and exit methods.
024 *
025 * @author Kuali Rice Team (rice.collab@kuali.org)
026 */
027public interface ControllerService {
028
029    /**
030     * Initial method called when requesting a new view instance.
031     *
032     * @param form form instance containing the model data
033     * @return ModelAndView instance for rendering the view
034     */
035    ModelAndView start(UifFormBase form);
036
037    /**
038     * Invokes the configured {@link org.kuali.rice.krad.uif.view.ViewAuthorizer} to verify the user has access to
039     * open the view.
040     *
041     * @throws org.kuali.rice.krad.exception.AuthorizationException thrown if user does not have access to the view
042     */
043    void checkViewAuthorization(UifFormBase form) throws AuthorizationException;
044
045    /**
046     * Invoked when a session timeout occurs.
047     *
048     * @param form form instance containing the model data
049     * @return ModelAndView instance for rendering the view
050     */
051    ModelAndView sessionTimeout(UifFormBase form);
052
053    /**
054     * Invoked when the cancel action is invoked on a view.
055     *
056     * @param form form instance containing the model data
057     * @return ModelAndView instance for rendering the view
058     */
059    ModelAndView cancel(UifFormBase form);
060}