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
021import javax.servlet.http.HttpServletResponse;
022
023/**
024 * Controller service that provides methods for working with the multi-file upload component.
025 *
026 * @author Kuali Rice Team (rice.collab@kuali.org)
027 */
028public interface FileControllerService {
029
030    /**
031     * Invoked by the multiFile upload element to add a file object to the collection it controls.
032     *
033     * @param form form instance containing the file data
034     * @return ModelAndView instance for rendering the view
035     */
036    ModelAndView addFileUploadLine(UifFormBase form);
037
038    /**
039     * Invoked by the multiFile upload widget to delete a file; Inform the model of file to delete.
040     *
041     * @param form form instance containing the file data
042     * @return ModelAndView instance for rendering the view
043     */
044    ModelAndView deleteFileUploadLine(UifFormBase form);
045
046    /**
047     * Invoked by the multiFile upload widget to get the file contents for a file upload line.
048     *
049     * @param form form instance containing the file request data
050     * @param response Http response for streaming back the file contents
051     */
052    void getFileFromLine(UifFormBase form, HttpServletResponse response);
053}