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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of efaps-kernel Show documentation

eFaps is a framework used to map objects with or without attached files to a relational database and optional file systems (only for attaches files). Configurable access control can be provided down to object and attribute level depending on implementation and use case. Depending on requirements, events (like triggers) allow to implement business logic and to separate business logic from user interface. The framework includes integrations (e.g. webdav, full text search) and a web application as 'simple' configurable user interface. Some best practises, example web application modules (e.g. team work module) support administrators and implementers using this framework.

There is a newer version: 3.2.0

Show newest version

/*
 * Copyright 2003 - 2012 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: 7483 $
 * Last Changed:    $Date: 2012-05-11 11:57:38 -0500 (Fri, 11 May 2012) $
 * 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;

/**
 * @author The eFaps Team
 * @version $Id: Command.java 7483 2012-05-11 16:57:38Z [email protected] $
 * TODO: description
 */
public class Command
    extends AbstractCommand
{

    /**
     * Cache for the commands.
     */
    private static final CommandCache CACHE = new CommandCache();

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

    /**
     * Static getter method for the command {@link #CACHE}.
     *
     * @return value of static variable {@link #CACHE}
     */
    protected static AbstractUserInterfaceObjectCache getCache()
    {
        return Command.CACHE;
    }

    /**
     * Returns for given parameter UUID the instance of class
     * {@link Command}.
     *
     * @param _uuid         UUID to search in the cache
     * @return instance of class {@link Command}
     * @see #CACHE
     */
    public static Command get(final UUID _uuid)
    {
        return Command.CACHE.get(_uuid);
    }

    /**
     * Returns for given parameter _id the instance of class
     * {@link Command}.
     *
     * @param _id       id to search in the cache
     * @return instance of class {@link Command}
     * @see #CACHE
     */
    public static Command get(final long _id)
    {
        return Command.CACHE.get(_id);
    }

    /**
     * Returns for given parameter _name the instance of class
     * {@link Command}.
     *
     * @param _name     name to search in the cache
     * @return instance of class {@link Command}
     * @see #CACHE
     */
    public static Command get(final String _name)
    {
        return Command.CACHE.get(_name);
    }

    /**
     * Cache for Commands.
     */
    private static class CommandCache
        extends AbstractUserInterfaceObjectCache
    {

        /**
         *
         */
        protected CommandCache()
        {
            super(Command.class);
        }

        /**
         * {@inheritDoc}
         */
        @Override
        protected Type getType()
            throws EFapsException
        {
            return CIAdminUserInterface.Command.getType();
        }
    }
}