001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://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: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://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.ui.apps;
029
030import java.util.List;
031
032/**
033 * Interface for apps which perform CRUD operations on any kind of element like CmsSites or CmsScheduledJobs.
034 * @param <T> the type of element.
035 */
036public interface I_CmsCRUDApp<T> {
037
038    /**
039     * Creates the element of type T in the system.<p>
040     *
041     * @param element to be saved
042     */
043    void createElement(T element);
044
045    /**
046     * Performs a default action.
047     *
048     * @param elementId id of element
049     */
050    void defaultAction(String elementId);
051
052    /**
053     * Delete the given List of elements.<p>
054     *
055     * @param elementId of elements to be deleted
056     */
057    void deleteElements(List<String> elementId);
058
059    /**
060     * Get all Elements.<p>
061     *
062     * @return a list of all elements
063     */
064    List<T> getAllElements();
065
066    /**
067     * Reads out an element.<p>
068     *
069     * @param elementId of the object
070     * @return the object of type T
071     */
072    T getElement(String elementId);
073
074    /**
075     * Writes a changed element to the system which already exists.<p>
076     *
077     * @param element to be saved
078     */
079    void writeElement(T element);
080}