// Response - a conferencing response
//
// Copyright (C) 1996 by Jef Poskanzer <jef@mail.acme.com>.  All rights reserved.
//
// 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.
//
// THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
// ANY EXPRESS 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 THE AUTHOR OR 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.
//
// Visit the ACME Labs Java page for up-to-date versions of this and other
// fine Java utilities: http://www.acme.com/java/

package Acme.Conf;

import java.util.*;

/// A conferencing response.
// <P>
// A response is contained in a topic.
// Each response has an author (with optional pseudonym), and the response text.
// It also has flags saying whether it's hidden or scribbled.
// <P>
// This is an abstract class with separate implementations on the
// client and server sides, mirrored via RPC.
// <P>
// <A HREF="/resources/classes/Acme/Conf/Response.java">Fetch the software.</A><BR>
// <A HREF="/resources/classes/Acme.tar.gz">Fetch the entire Acme package.</A>
// <P>
// @see Topic

public abstract class Response
    {

    /// The number of this response.
    public abstract int getNumber();

    /// The date the response was entered.
    public abstract long getDate();
    
    /// The author of the response.
    public abstract User getAuthor();
    
    /// The author's pseudonym for this response - often the same as
    // the real name, but not always.
    public abstract String getPseud();

    /// The text of the response.
    public abstract String getText();

    /// Whether the response is hidden.
    // The text of hidden responses is normally not shown.
    public abstract boolean isHidden();

    /// Whether the response is scribbled.
    // Scribbling is similar to hiding, but the text is really gone and
    // can never be shown.
    public abstract boolean isScribbled();

    /// The user who did the scribbling.
    public abstract User getScribbler();

    /// The time of the scribble.
    public abstract long getScribbleDate();


    /// Hide this response.
    // <P>
    // Only the author or a host may do this.
    public abstract void hide( Session session );

    /// Unhide this response.
    // <P>
    // Only the author or a host may do this.
    public abstract void unhide( Session session );

    /// Scribble this response.  Scribbling cannot be undone.
    // <P>
    // Only the author or a host may do this.
    public abstract void scribble( Session session );

    }