forum.java

Jive 是一个系统工程

/**
 * $RCSfile: Forum.java,v $
 * $Revision: 1.4 $
 * $Date: 2000/12/21 17:46:53 $
 *
 * 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.Date;
import java.util.Iterator;
import java.util.Enumeration;

/**
 * A top level container for discussions. It contains a list of threads, each
 * of which contains a tree of messages.
 */
public interface Forum {

    /**
     * Returns the unique id of the forum.
     *
     * @return the unique id of the forum.
     */
    public int getID();

    /**
     * Returns the name of the forum. Every forum name in the system must be
     * unique. However, this restriction allows one to lookup a forum by name
     * as well as by ID.
     *
     * @return the name of the forum.
     * @see ForumFactory#getForum(String)
     */
    public String getName();

    /**
     * Sets the name of a the forum. Every forum name in the system must be
     * unique. However, this restriction allows one to lookup a forum by name
     * as well as by ID.<p>
     *
     * An exception will be thrown if a forum with the same name as the new
     * name already exists.
     *
     * @param name the name of the forum.
     * @throws UnauthorizedException if does not have ADMIN permissions.
     * @throws ForumAlreadyExistsException if a forum with the specified name
     *      already exists.
     */
    public void setName(String name) throws UnauthorizedException,
            ForumAlreadyExistsException;

    /**
     * Returns the description of the forum.
     *
     * @return the description of the forum.
     */
    public String getDescription();

    /**
     * Sets the description of the forum.
     *
     * @param description the description of the forum.
     * @throws UnauthorizedException if does not have ADMIN permissions.
     */
    public void setDescription(String description) throws UnauthorizedException;

    /**
     * Returns the Date that the forum was created.
     *
     * @return the Date the forum was created.
     */
    public Date getCreationDate();

    /**
     * Sets the creation date of the forum. In most cases, the creation date
     * will default to when the forum was entered into the system. However,
     * the creation date needs to be set manually when importing data.
     * In other words, skin authors should ignore this method since it only
     * intended for system maintenance.
     *
     * @param creationDate the date the forum was created.
     * @throws UnauthorizedException if does not have ADMIN permissions.
     */
    public void setCreationDate(Date creationDate) throws UnauthorizedException;

    /**
     * Returns the Date that the forum was last modified. In other words, the
     * date of the most recent message or thread in the forum.
     *
     * @return the Date the forum was last modified.
     */
    public Date getModifiedDate();

    /**
     * Sets the date the forum was last modified. In most cases, last modifed
     * will default to when the forum data was last changed. However,
     * the last modified date needs to be set manually when importing data.
     * In other words, skin authors should ignore this method since it only
     * intended for system maintenance.
     *
     * @param modifiedDate the date the forum was modified.
     * @throws UnauthorizedException if does not have ADMIN permissions.
     */
    public void setModifiedDate(Date modifiedDate) throws UnauthorizedException;

    /**
     * Returns an extended property of the forum. Each forum can have an
     * arbitrary number of extended properties. This allows for enhanced
     * functionality that is not part of the base interface.
     *
     * @param name the name of the property to get.
     * @param the value of the property specified by name.
     */
    public String getProperty(String name);

    /**
     * Sets an extended property of the forum. Each forum can have an
     * arbitrary number of extended properties. This allows for enhanced
     * functionality that is not part of the base interface.
     *
     * @param name the name of the property to set.
     * @param value the new value for the property.
     */
    public void setProperty(String name, String value) throws UnauthorizedException;

    /**
     * Returns an Enumeration of all the names of the forum properties.
     *
     * @return an Enumeration of all the names of the forum properties.
     */
    public Enumeration propertyNames();

    /**
     * Returns true if this forum is moderated. When a forum is moderated,
     * posted messages and threads must first be approved by a user with
     * moderator permissions.<p>
     *
     * Note: this feature not yet implemented.
     *
     * @param type should be either Forum.THREAD or Forum.MESSAGE
     * @return true if the forum is moderated.
     */
    //public boolean isModerated(int type);

    /**
     * Sets whether the forum is moderated. When a forum is moderated,
     * posted messages and threads must first be approved by a user with
     * moderator permissions.<p>
     *
     * Note: this feature not yet implemented.
     *
     * @param type should be either Forum.THREAD or Forum.MESSAGE
     * @throws UnauthorizedException if does not have ADMIN permissions.
     */
    //public void setModerated(int type, boolean moderated)
    //        throws UnauthorizedException;

    /**
     * Factory method to create a Thread.
     *
     * @param forum the forum to create the thread in.
     * @param rootMessage the root message of the thread.