RibbonGroupsPack.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 java.util.List;

public interface RibbonGroupsPack {

    /**
     * Gets contained ribbon groups
     * 
     * @return List of ribbon groups contained in this object
     */
    List<InternalRibbonGroup> getGroups();

    /**
     * Gets contained ribbon group with specified name
     * 
     * @return ribbon group contained in this object with specified name or null if group was not found
     */
    InternalRibbonGroup getGroupByName(String groupName);

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

    /**
     * Gets ribbon group pack with only updated groups - internal usage only
     * 
     * @return ribbon group pack with only updated groups
     */
    RibbonGroupsPack getUpdate();

}