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