// User - a conferencing user
//
// 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;

/// A conferencing user.
// <P>
// A person who uses the conferencing system.
// Each user has a userid (guaranteed unique across the system), a
// real name, an email address, a URL, and a bio.
// The user also has a list of conferences he or she is interested in.
// <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/User.java">Fetch the software.</A><BR>
// <A HREF="/resources/classes/Acme.tar.gz">Fetch the entire Acme package.</A>
// <P>
// @see Confsys

public abstract class User
    {

    /// The user's userid.  A short alphanumeric string, guaranteed unique
    // across the conferencing system, and immutable.
    public abstract String getUserid();

    /// The user's real name.
    public abstract String getRealName();

    /// The user's email address.
    public abstract String getEmail();

    /// The user's URL.
    public abstract String getUrl();

    /// The user's biographical information / .plan file.
    public abstract String getBio();

    /// The user's conferences list.
    public abstract Conflist getConflist();

    /// The user's seen-table.
    public abstract Seentab getSeentab();


    /// Set the user's real name.
    // <P>
    // Only the administrator may do this.
    public abstract void setRealName( Session session, String realName );

    /// Set the user's email address.
    // <P>
    // Only the user or the administrator may do this.
    public abstract void setEmail( Session session, String email );

    /// Set the user's URL.
    // <P>
    // Only the user or the administrator may do this.
    public abstract void setUrl( Session session, String url );

    /// Set the user's biographical information / .plan file.
    // <P>
    // Only the user or the administrator may do this.
    public abstract void setBio( Session session, String bio );


    // Methods to enable Hashtable usage.  These depend only
    // on the userid field, which is immutable.

    public abstract int hashCode();

    public abstract boolean equals( Object obj );

    }