1 /**
2 * Copyright 2005-2016 The Kuali Foundation
3 *
4 * Licensed under the Educational Community License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.opensource.org/licenses/ecl2.php
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package org.kuali.rice.krad.web.service;
17
18 import org.kuali.rice.krad.exception.AuthorizationException;
19 import org.kuali.rice.krad.web.form.UifFormBase;
20 import org.springframework.web.servlet.ModelAndView;
21
22 /**
23 * Controller service that provides the basic entry and exit methods.
24 *
25 * @author Kuali Rice Team (rice.collab@kuali.org)
26 */
27 public interface ControllerService {
28
29 /**
30 * Initial method called when requesting a new view instance.
31 *
32 * @param form form instance containing the model data
33 * @return ModelAndView instance for rendering the view
34 */
35 ModelAndView start(UifFormBase form);
36
37 /**
38 * Invokes the configured {@link org.kuali.rice.krad.uif.view.ViewAuthorizer} to verify the user has access to
39 * open the view.
40 *
41 * @throws org.kuali.rice.krad.exception.AuthorizationException thrown if user does not have access to the view
42 */
43 void checkViewAuthorization(UifFormBase form) throws AuthorizationException;
44
45 /**
46 * Invoked when a session timeout occurs.
47 *
48 * @param form form instance containing the model data
49 * @return ModelAndView instance for rendering the view
50 */
51 ModelAndView sessionTimeout(UifFormBase form);
52
53 /**
54 * Invoked when the cancel action is invoked on a view.
55 *
56 * @param form form instance containing the model data
57 * @return ModelAndView instance for rendering the view
58 */
59 ModelAndView cancel(UifFormBase form);
60 }