001/**
002 * Copyright 2005-2014 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 saves.
023 *
024 * @author Kuali Rice Team (rice.collab@kuali.org)
025 */
026public interface SaveControllerService {
027
028    /**
029     * Save the form.
030     *
031     * <p>Save is not implemented by KRAD and must be overriden with an implementation to persist changes
032     * to a db.  By default, this will just refresh the View.</p>
033     *
034     * @param form the form
035     * @return ModelAndView with the updated content
036     */
037    ModelAndView save(UifFormBase form);
038
039    /**
040     * Save the field of the form at the propertyName specified by saveFieldPath (in request params sent); the
041     * field is already updated on the form at the time of this invocation.
042     *
043     * <p>SaveField is not implemented by KRAD and must be overriden with an implementation to persist changes
044     * to a db.  By default, this will just refresh the field specified by updateComponentId.</p>
045     *
046     * @param form the form with the updated field
047     * @return ModelAndView which contains the updated component
048     */
049    ModelAndView saveField(UifFormBase form);
050
051}