group.java

Jive Forums 1.0 src

/**
 * Group.java
 * May 08, 2000
 *
 * Copyright (C) 2000 CoolServlets.com. All rights reserved.
 *
 * ===================================================================
 * The Apache Software License, Version 1.1
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution,
 *    if any, must include the following acknowledgment:
 *       "This product includes software developed by
 *        CoolServlets.com (http://www.coolservlets.com)."
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "Jive" and "CoolServlets.com" must not be used to
 *    endorse or promote products derived from this software without
 *    prior written permission. For written permission, please
 *    contact [e-mail].
 *
 * 5. Products derived from this software may not be called "Jive",
 *    nor may "Jive" appear in their name, without prior written
 *    permission of CoolServlets.com.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL COOLSERVLETS.COM OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of CoolServlets.com. For more information
 * on CoolServlets.com, please see <http://www.coolservlets.com>.
 */

package com.coolservlets.forum;

import java.util.*;
//JDK1.1// import com.sun.java.util.collections.*;

/**
 * Organizes Users into a group for easier permissions management at the
 * Forum level. In this way, Groups essentially serve the same purpose that
 * they do in Unix. For example, MODERATOR permissions can be set per forum.
 * A forum administrator may wish to create a Moderators group that has
 * MODERATOR permissions in the forum. Then, users can be added to that
 * group and automatically receive MODERATOR permissions in that forum.
 * <p>
 * Security for Group objects is provide by GroupProxy protection proxy objects.
 *
 * @see User
 */
public interface Group {

    /**
     * Return the group id.
     */
    public int getID();

    /**
     * Returns the group name.
     */
    public String getName();

    /**
     * Sets the group name.
     *
     * @param name the new name for the group.
     *
     * @throws UnauthorizedException
     */
    public void setName(String name) throws UnauthorizedException;

    /**
     * Returns the group description.
     */
    public String getDescription();

    /**
     * Sets the group description.
     *
     * @param name the new description for the group.
     *
     * @throws UnauthorizedException
     */
    public void setDescription(String description) throws UnauthorizedException;

    /**
     * Grants administrator privledges of the group to a user.
     *
     * @param user the User to grant adminstrative privledges to.
     *
     * @throws UnauthorizedException
     */
    public void addAdministrator(User user) throws UnauthorizedException;

    /**
     * Revokes administrator privledges of the group to a user.
     *
     * @param user the User to grant adminstrative privledges to.
     *
     * @throws UnauthorizedException
     */
    public void removeAdministrator(User user) throws UnauthorizedException;

    /**
     * Adds a user to the group.
     *
     * @param user the User to add to the group.
     *
     * @throws UnauthorizedException
     */
    public void addUser(User user) throws UnauthorizedException;

    /**
     * Removes a user from the group.
     *
     * @param user the User to remove from the group.
     *
     * @throws UnauthorizedException
     */
    public void removeUser(User user) throws UnauthorizedException;

    /**
     * Returns true if the User has group administrator permissions.
     */
    public boolean isAdministrator(User user);

    /**
     * Returns true if if the User is a member of the group.
     */
    public boolean isMember(User user);

    /**
     * Returns the number of group administrators.
     */
    public int getAdministratorCount();

    /**
     * Returns the number of group members.
     */
    public int getUserCount();

    /**
     * An iterator for all the users that are members of the group.
     */
    public Iterator users();

    /**
     * An iterator for all the users that are administrators of the group.
     */
    public Iterator administrators();

    /**
     * Returns the permissions for the group that correspond to the
     * passed-in Authorization. 
     *
     * @param authorization the auth token to lookup permissions for.
     */
    public abstract ForumPermissions getPermissions(Authorization authorization);

    /**
     * Returns true if the handle on the object has the permission specified.
     * A list of possible permissions can be found in the ForumPermissions
     * class. Certain methods of this class are restricted to certain
     * permissions as specified in the method comments.
     *
     * @see ForumPermissions
     */
    public boolean hasPermission(int type);
}