1 /**
2 * This file Copyright (c) 2013-2015 Magnolia International
3 * Ltd. (http://www.magnolia-cms.com). All rights reserved.
4 *
5 *
6 * This file is dual-licensed under both the Magnolia
7 * Network Agreement and the GNU General Public License.
8 * You may elect to use one or the other of these licenses.
9 *
10 * This file is distributed in the hope that it will be
11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12 * implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14 * Redistribution, except as permitted by whichever of the GPL
15 * or MNA you select, is prohibited.
16 *
17 * 1. For the GPL license (GPL), you can redistribute and/or
18 * modify this file under the terms of the GNU General
19 * Public License, Version 3, as published by the Free Software
20 * Foundation. You should have received a copy of the GNU
21 * General Public License, Version 3 along with this program;
22 * if not, write to the Free Software Foundation, Inc., 51
23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24 *
25 * 2. For the Magnolia Network Agreement (MNA), this file
26 * and the accompanying materials are made available under the
27 * terms of the MNA which accompanies this distribution, and
28 * is available at http://www.magnolia-cms.com/mna.html
29 *
30 * Any modifications to this file must keep this entire header
31 * intact.
32 *
33 */
34 package info.magnolia.ui.form.field.upload;
35
36 import java.io.File;
37
38 import com.vaadin.data.Item;
39
40 /**
41 * Used by Upload fields to handle Items and perform the bridge between a Vaadin Item and a UploadReceiver <br>
42 * <b>FileItemWrapper is used by :</b><br>
43 * - Implementation class of {@link AbstractUploadField} in order to display File information's: newly Uploaded File or already Stored File by using the <b>getter's</b><br>
44 * - {@link AbstractUploadField} in order to update the Item based on the Uploaded File (Dropped File): This is done during handling of events like UploadFinished or UploadFailed...
45 */
46 public interface FileItemWrapper {
47 /**
48 * Populate the FileItemWrapper with the provided {@link Item}.<br>
49 * Generally done in the constructor (in Builder).
50 */
51 public void populateFromItem(Item item);
52
53 /**
54 * Populate the FileItemWrapper with the provided {@link UploadReceiver}.
55 */
56 public void populateFromReceiver(UploadReceiver receiver);
57
58 /**
59 * Clear all properties.
60 */
61 public void clearProperties();
62
63 /**
64 * Used to restore the previous Uploaded File if existing.
65 */
66 public void reloadPrevious();
67
68 /**
69 * Return true if the binaryData is not empty.
70 * false otherwise.
71 */
72 public boolean isEmpty();
73
74
75 public long getFileSize();
76
77 public String getMimeType();
78
79 public String getExtension();
80
81 public String getFileName();
82
83 public File getFile();
84
85 }