InternalRibbonGroup.java

/**
 * ***************************************************************************
 * Copyright (c) 2010 Qcadoo Limited
 * Project: Qcadoo Framework
 * Version: 1.4
 *
 * This file is part of Qcadoo.
 *
 * Qcadoo is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published
 * by the Free Software Foundation; either version 3 of the License,
 * or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty
 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 * ***************************************************************************
 */
package com.qcadoo.view.internal.ribbon.model;

import org.json.JSONException;
import org.json.JSONObject;

import com.qcadoo.view.api.ribbon.RibbonGroup;

public interface InternalRibbonGroup extends RibbonGroup {

    /**
     * Add item to this group
     * 
     * @param item
     *            item to add
     */
    void addItem(final InternalRibbonActionItem item);

    /**
     * Generates JSON representation of this ribbon group
     * 
     * @return JSON representation of this ribbon group
     * @throws JSONException
     */
    JSONObject getAsJson() throws JSONException;

    /**
     * Gets copy of this group - internal usage only
     * 
     * @return copy of this group
     */
    InternalRibbonGroup getCopy();

    /**
     * Gets ribbon group with only updated items - internal usage only
     * 
     * @return ribon group with only updated fields
     */
    InternalRibbonGroup getUpdate();

    /**
     * Returns identifier of plugin that created this group or null when no such plugin identifier defined
     * 
     * @return identifier of plugin that created this group or null when no such plugin identifier defined
     */
    String getExtensionPluginIdentifier();

    /**
     * Sets identifier of plugin that created this group - internal usage only
     * 
     * @param extensionPluginIdentifier
     *            identifier of plugin that created this group
     */
    void setExtensionPluginIdentifier(String extensionPluginIdentifier);
}