001package org.apache.fulcrum.security.entity; 002 003import java.io.Serializable; 004 005/* 006 * Licensed to the Apache Software Foundation (ASF) under one 007 * or more contributor license agreements. See the NOTICE file 008 * distributed with this work for additional information 009 * regarding copyright ownership. The ASF licenses this file 010 * to you under the Apache License, Version 2.0 (the 011 * "License"); you may not use this file except in compliance 012 * with the License. You may obtain a copy of the License at 013 * 014 * http://www.apache.org/licenses/LICENSE-2.0 015 * 016 * Unless required by applicable law or agreed to in writing, 017 * software distributed under the License is distributed on an 018 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 019 * KIND, either express or implied. See the License for the 020 * specific language governing permissions and limitations 021 * under the License. 022 */ 023 024/** 025 * This classes is the base class for any security entity including groups, 026 * users, roles and permissions (and potentially others depending on the model 027 * chosen) 028 * 029 * @author <a href="mailto:epugh@upstate.com">Eric Pugh</a> 030 * @author <a href="mailto:Rafal.Krzewski@e-point.pl">Rafal Krzewski</a> 031 * @author <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a> 032 * @author <a href="mailto:marco@intermeta.de">Marco Knüttel</a> 033 * @version $Id$ 034 */ 035 036public interface SecurityEntity extends Serializable 037{ 038 /** 039 * Get the Name of the SecurityEntity. 040 * 041 * @return The Name of the SecurityEntity. 042 */ 043 String getName(); 044 045 /** 046 * Sets the Name of the SecurityEntity. 047 * 048 * @param name 049 * Name of the SecurityEntity. 050 */ 051 void setName(String name); 052 053 /** 054 * Get the Id of the SecurityEntity. 055 * 056 * @return The Id of the SecurityEntity. 057 */ 058 Object getId(); 059 060 /** 061 * Sets the Id of the SecurityEntity. 062 * 063 * @param id 064 * The new Id of the SecurityEntity 065 */ 066 void setId(Object id); 067}