View Javadoc

1   package org.apache.turbine.om.security;
2   
3   /*
4    * Copyright 2001-2005 The Apache Software Foundation.
5    *
6    * Licensed under the Apache License, Version 2.0 (the "License")
7    * you may not use this file except in compliance with the License.
8    * You may obtain a copy of the License at
9    *
10   *     http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  
19  /***
20   * This class represents a Group of Users in the system that are associated
21   * with specific entity or resource. The users belonging to the Group may have
22   * various Roles. The Permissions to perform actions upon the resource depend
23   * on the Roles in the Group that they are assigned.
24   *
25   * @author <a href="mailto:Rafal.Krzewski@e-point.pl">Rafal Krzewski</a>
26   * @author <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a>
27   * @author <a href="mailto:marco@intermeta.de">Marco Kn&uuml;ttel</a>
28   * @version $Id: SecurityEntity.java 264148 2005-08-29 14:21:04Z henning $
29   */
30  
31  public interface SecurityEntity
32  {
33      /***
34       * Get the Name of the SecurityEntity.
35       *
36       * @return The Name of the SecurityEntity.
37       */
38      String getName();
39  
40      /***
41       * Sets the Name of the SecurityEntity.
42       *
43       * @param name Name of the SecurityEntity.
44       */
45      void setName(String name);
46  
47      /***
48       * Get the Id of the SecurityEntity.
49       *
50       * @return The Id of the SecurityEntity.
51       */
52      int getId();
53  
54      /***
55       * Get the Id of the SecurityEntity as an
56       * Integer object.
57       *
58       * @return The Id of the SecurityEntity.
59       */
60      Integer getIdAsObj();
61  
62      /***
63       * Sets the Id of the SecurityEntity.
64       *
65       * @param id The new Id of the SecurityEntity
66       */
67      void setId(int id);
68  }