| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| SecurityEntity |
|
| 1.0;1 |
| 1 | package org.apache.turbine.om.security; | |
| 2 | ||
| 3 | /* | |
| 4 | * Licensed to the Apache Software Foundation (ASF) under one | |
| 5 | * or more contributor license agreements. See the NOTICE file | |
| 6 | * distributed with this work for additional information | |
| 7 | * regarding copyright ownership. The ASF licenses this file | |
| 8 | * to you under the Apache License, Version 2.0 (the | |
| 9 | * "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 957284 2010-06-23 17:53:31Z tv $ | |
| 32 | */ | |
| 33 | ||
| 34 | public interface SecurityEntity | |
| 35 | { | |
| 36 | /** | |
| 37 | * Get the Name of the SecurityEntity. | |
| 38 | * | |
| 39 | * @return The Name of the SecurityEntity. | |
| 40 | */ | |
| 41 | String getName(); | |
| 42 | ||
| 43 | /** | |
| 44 | * Sets the Name of the SecurityEntity. | |
| 45 | * | |
| 46 | * @param name Name of the SecurityEntity. | |
| 47 | */ | |
| 48 | void setName(String name); | |
| 49 | ||
| 50 | /** | |
| 51 | * Get the Id of the SecurityEntity. | |
| 52 | * | |
| 53 | * @return The Id of the SecurityEntity. | |
| 54 | */ | |
| 55 | int getId(); | |
| 56 | ||
| 57 | /** | |
| 58 | * Get the Id of the SecurityEntity as an | |
| 59 | * Integer object. | |
| 60 | * | |
| 61 | * @return The Id of the SecurityEntity. | |
| 62 | */ | |
| 63 | Integer getIdAsObj(); | |
| 64 | ||
| 65 | /** | |
| 66 | * Sets the Id of the SecurityEntity. | |
| 67 | * | |
| 68 | * @param id The new Id of the SecurityEntity | |
| 69 | */ | |
| 70 | void setId(int id); | |
| 71 | } |