001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (https://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software, please see the
018 * company website: https://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: https://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.gwt.shared;
029
030/**
031 * Extended attributes for editable data generated by e.g. the <cms:display> tag.
032 *
033 * <p>This is mainly to simplify the implementation, so we can use the GWT AutoBean mechanism
034 * for future additions to the editable data (as long as they're convertible to JSON) and don't have
035 * to individually write the attributes to JSON.
036 */
037public interface I_CmsEditableDataExtensions {
038
039    /** Gets the 'expired' text for the availability information. */
040    String getExpiredText();
041
042    /** Gets the 'released' text for the availability information. */
043    String getReleasedText();
044
045    /**
046     * Gets the upload folder.
047     *
048     * @return the upload folder
049     */
050    String getUploadFolder();
051
052    /**
053     * Returns true if the upload is enabled.
054     *
055     * @return true if the upload is enabled
056     */
057    boolean isUploadEnabled();
058
059    /**
060     * Sets the 'expire' text for the availability information.
061     *
062     * @param expiredText the text
063     */
064    void setExpiredText(String expiredText);
065
066    /**
067     * Sets the 'release' text for the availability information.
068     *
069     * @param releasedText the text
070     */
071    void setReleasedText(String releasedText);
072
073    /**
074     * Enables/disables uploading.
075     *
076     * @param enabled true if the upload should be enabled
077     */
078    void setUploadEnabled(boolean enabled);
079
080    /**
081     * Sets the upload folder.
082     *
083     * @param uploadFolder the upload folder
084     */
085    void setUploadFolder(String uploadFolder);
086
087}