    001    package org.apache.turbine.om.security;
    002
    003    /*
    004     * Licensed to the Apache Software Foundation (ASF) under one
    005     * or more contributor license agreements.  See the NOTICE file
    006     * distributed with this work for additional information
    007     * regarding copyright ownership.  The ASF licenses this file
    008     * to you under the Apache License, Version 2.0 (the
    009     * "License"); you may not use this file except in compliance
    010     * with the License.  You may obtain a copy of the License at
    011     *
    012     *   http://www.apache.org/licenses/LICENSE-2.0
    013     *
    014     * Unless required by applicable law or agreed to in writing,
    015     * software distributed under the License is distributed on an
    016     * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    017     * KIND, either express or implied.  See the License for the
    018     * specific language governing permissions and limitations
    019     * under the License.
    020     */
    021
    022    /**
    023     * This class represents a Group of Users in the system that are associated
    024     * with specific entity or resource. The users belonging to the Group may have
    025     * various Roles. The Permissions to perform actions upon the resource depend
    026     * on the Roles in the Group that they are assigned.
    027     *
    028     * @author <a href="mailto:Rafal.Krzewski@e-point.pl">Rafal Krzewski</a>
    029     * @author <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a>
    030     * @author <a href="mailto:marco@intermeta.de">Marco Kn&uuml;ttel</a>
    031     * @version $Id: SecurityEntity.java 957284 2010-06-23 17:53:31Z tv $
    032     */
    033
    034    public interface SecurityEntity
    035    {
    036        /**
    037         * Get the Name of the SecurityEntity.
    038         *
    039         * @return The Name of the SecurityEntity.
    040         */
    041        String getName();
    042
    043        /**
    044         * Sets the Name of the SecurityEntity.
    045         *
    046         * @param name Name of the SecurityEntity.
    047         */
    048        void setName(String name);
    049
    050        /**
    051         * Get the Id of the SecurityEntity.
    052         *
    053         * @return The Id of the SecurityEntity.
    054         */
    055        int getId();
    056
    057        /**
    058         * Get the Id of the SecurityEntity as an
    059         * Integer object.
    060         *
    061         * @return The Id of the SecurityEntity.
    062         */
    063        Integer getIdAsObj();
    064
    065        /**
    066         * Sets the Id of the SecurityEntity.
    067         *
    068         * @param id The new Id of the SecurityEntity
    069         */
    070        void setId(int id);
    071    }