org.apache.fulcrum.security.entity.SecurityEntity Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of fulcrum-security-api Show documentation

Fulcrum Security Basic API

There is a newer version: 3.0.0

package org.apache.fulcrum.security.entity;

import java.io.Serializable;

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

/**
 * This classes is the base class for any security entity including groups,
 * users, roles and permissions (and potentially others depending on the model
 * chosen)
 * 
 * @author Eric Pugh
 * @author Rafal Krzewski
 * @author Henning P. Schmiedehausen
 * @author Marco Knüttel
 * @version $Id: SecurityEntity.java 1792752 2017-04-26 14:36:57Z gk $
 */

public interface SecurityEntity extends Serializable
{
    /**
     * Get the Name of the SecurityEntity.
     * 
     * @return The Name of the SecurityEntity.
     */
    String getName();

    /**
     * Sets the Name of the SecurityEntity.
     * 
     * @param name
     *            Name of the SecurityEntity.
     */
    void setName(String name);

    /**
     * Get the Id of the SecurityEntity.
     * 
     * @return The Id of the SecurityEntity.
     */
    Object getId();

    /**
     * Sets the Id of the SecurityEntity.
     * 
     * @param id
     *            The new Id of the SecurityEntity
     */
    void setId(Object id);
}