01: package org.apache.turbine.om.security;
02:
03: /*
04: * Copyright 2001-2005 The Apache Software Foundation.
05: *
06: * Licensed under the Apache License, Version 2.0 (the "License")
07: * you may not use this file except in compliance with the License.
08: * You may obtain a copy of the License at
09: *
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üttel</a>
28: * @version $Id: SecurityEntity.java 264148 2005-08-29 14:21:04Z henning $
29: */
30:
31: public interface SecurityEntity {
32: /**
33: * Get the Name of the SecurityEntity.
34: *
35: * @return The Name of the SecurityEntity.
36: */
37: String getName();
38:
39: /**
40: * Sets the Name of the SecurityEntity.
41: *
42: * @param name Name of the SecurityEntity.
43: */
44: void setName(String name);
45:
46: /**
47: * Get the Id of the SecurityEntity.
48: *
49: * @return The Id of the SecurityEntity.
50: */
51: int getId();
52:
53: /**
54: * Get the Id of the SecurityEntity as an
55: * Integer object.
56: *
57: * @return The Id of the SecurityEntity.
58: */
59: Integer getIdAsObj();
60:
61: /**
62: * Sets the Id of the SecurityEntity.
63: *
64: * @param id The new Id of the SecurityEntity
65: */
66: void setId(int id);
67: }
|