org.efaps.admin.ui.Menu Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2003 - 2013 The eFaps Team
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * Revision:        $Rev: 8896 $
 * Last Changed:    $Date: 2013-02-19 22:03:59 -0500 (Tue, 19 Feb 2013) $
 * Last Changed By: $Author: [email protected] $
 */

package org.efaps.admin.ui;

import java.util.UUID;

import org.efaps.admin.datamodel.Type;
import org.efaps.ci.CIAdminUserInterface;
import org.efaps.util.EFapsException;
import org.efaps.util.cache.CacheReloadException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * @author The eFaps Team
 * @version $Id: Menu.java 8896 2013-02-20 03:03:59Z [email protected] $
 *
 */
public class Menu
    extends AbstractMenu
{

    /**
     * Logging instance used in this class.
     */
    protected static final Logger LOG = LoggerFactory.getLogger(Menu.class);

    /**
     * Constructor to set the id and name of the menu object.
     *
     * @param _id id of the command to set
     * @param _uuid uuid of this command
     * @param _name name of the command to set
     */
    public Menu(final Long _id,
                final String _uuid,
                final String _name)
    {
        super(_id, _uuid, _name);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    protected void add(final long _sortId,
                       final long _id)
        throws CacheReloadException
    {
        final Command command = Command.get(_id);
        if (command == null) {
            final Menu subMenu = Menu.get(_id);
            add(_sortId, subMenu);
        } else {
            add(_sortId, command);
        }
    }

    /**
     * Returns for given parameter _id the instance of class {@link Menu}
     * .
     *
     * @param _id id to search in the cache
     * @return instance of class {@link Menu}
     * @throws CacheReloadException on error
     */
    public static Menu get(final long _id)
        throws CacheReloadException
    {
        return AbstractUserInterfaceObject.get(_id, Menu.class, CIAdminUserInterface.Menu.getType());
    }

    /**
     * Returns for given parameter _name the instance of class
     * {@link Menu}.
     *
     * @param _name name to search in the cache
     * @return instance of class {@link Menu}
     * @throws CacheReloadException on error
     */
    public static Menu get(final String _name)
        throws CacheReloadException
    {
        return AbstractUserInterfaceObject.get(_name, Menu.class, CIAdminUserInterface.Menu.getType());
    }

    /**
     * Returns for given parameter UUID the instance of class
     * {@link Menu}.
     *
     * @param _uuid UUID to search in the cache
     * @return instance of class {@link Menu}
     * @throws CacheReloadException on error
     */
    public static Menu get(final UUID _uuid)
        throws CacheReloadException
    {
        return AbstractUserInterfaceObject.get(_uuid, Menu.class, CIAdminUserInterface.Menu.getType());
    }

    /**
     * Returns for given type the type tree menu. If no type tree menu is
     * defined for the type, it is searched if for parent type a menu is
     * defined.
     *
     * @param _type type for which the type tree menu is searched
     * @return type tree menu for given type if found; otherwise
     *         null.
     * @throws EFapsException on error
     */
    public static Menu getTypeTreeMenu(final Type _type)
        throws EFapsException
    {
        return _type.getTypeMenu();
    }
}