/* ======================================================================
The Bodington System Software License, Version 1.0
  
Copyright (c) 2001 The University of Leeds.  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.

3.  The end-user documentation included with the redistribution, if any,
must include the following acknowledgement:  "This product includes
software developed by the University of Leeds
(http://www.bodington.org/)."  Alternately, this acknowledgement may
appear in the software itself, if and wherever such third-party
acknowledgements normally appear.

4.  The names "Bodington", "Nathan Bodington", "Bodington System",
"Bodington Open Source Project", and "The University of Leeds" must not be
used to endorse or promote products derived from this software without
prior written permission. For written permission, please contact
d.gardner@leeds.ac.uk.

5.  The name "Bodington" may not appear in the name of products derived
from this software without prior written permission of the University of
Leeds.

THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO,  TITLE,  THE IMPLIED WARRANTIES 
OF QUALITY  AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO 
EVENT SHALL THE UNIVERSITY OF LEEDS 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 was originally created by the University of Leeds and may contain voluntary 
contributions from others.  For more information on the Bodington Open Source Project, please 
see http://bodington.org/

====================================================================== */

package org.bodington.messaging;

import java.io.*;
import java.util.Vector;
import java.util.Enumeration;

import org.bodington.server.BuildingServerException;
import org.bodington.sqldatabase.*;
import org.bodington.database.*;
import org.bodington.server.realm.User;
import org.bodington.text.BigString;


public class MessageSummary 
	implements java.io.Serializable
	{
	public static final int STYLE_PLAINTEXT=0;
	public static final int STYLE_SMARTTEXT=1;
	public static final int STYLE_HTML=2;
	
	
	// stored fields
	
	private PrimaryKey message_id;
	private PrimaryKey messaging_room_id;		//which room does the message belong to
	private PrimaryKey group_id;				//which group (if any) in that room does it belong to
	private PrimaryKey parent_message_id;		//which message is this indented from
	private PrimaryKey replyto_message_id;		//which message was selected to reply to
	private int left_index;						//visitation model left index
	private int right_index;					//visitation model right index
	

      /*
       * WebLearn inserted code; A Corfield 02/12/2003.
       */
        private java.sql.Timestamp edited_time;         //time this message was last edited.
      /*
       * WebLearn inserted code; A Corfield 02/12/2003.
       */
	private String editor_name;			//name of author at time of edit

	private java.sql.Timestamp created_time;	//time this message was created.
	private java.sql.Timestamp updated_time;	//time message was last edited/new sub message created.
	private PrimaryKey user_id;
	private String author_name;				//name of author at time of posting
	private boolean seen;
	private boolean draft;
	
	private String subject;
	private int style;
	
	private PrimaryKey big_string_id;			// reference to the actual message;
	
	
    public PrimaryKey getPrimaryKey()
		{
        return getMessageId();
        }

    public void setPrimaryKey(PrimaryKey key)
    	{
    	setMessageId( key );
    	}
    	
    public PrimaryKey getMessageId()
		{
        return message_id;
        }

    public void setMessageId(PrimaryKey key)
    	{
    	message_id = key;
    	}
    	

    public PrimaryKey getMessagingRoomId()
		{
        return messaging_room_id;
        }

    public void setMessagingRoomId(PrimaryKey key)
    	{
    	messaging_room_id = key;
    	}
    	

    
    public PrimaryKey getGroupId()
		{
        return group_id;
        }

    public void setGroupId(PrimaryKey key)
    	{
    	group_id = key;
    	}
    	

    
    public PrimaryKey getParentMessageId()
		{
        return parent_message_id;
        }

    public void setParentMessageId(PrimaryKey key)
    	{
    	parent_message_id = key;
    	}
    	

    public PrimaryKey getReplyToMessageId()
		{
        return replyto_message_id;
        }

    public void setReplyToMessageId(PrimaryKey key)
    	{
    	replyto_message_id = key;
    	}
    	

   	public int getLeftIndex()
		{
		return left_index;
		}
	public void setLeftIndex( int l )
		{
		left_index=l;
		}

	public int getRightIndex()
		{
		return right_index;
		}
	public void setRightIndex( int r )
		{
		right_index=r;
		}




	public java.sql.Timestamp getCreatedTime()
		{
		return created_time;
		}
	public void setCreatedTime( java.sql.Timestamp t )
		{
		created_time = t;
		}


	public java.sql.Timestamp getUpdatedTime()
		{
		return updated_time;
		}
	public void setUpdatedTime( java.sql.Timestamp t )
		{
		updated_time = t;
		}
        /**
         * Gets the time the message was last edited. <p>
         * <i>(WebLearn; A Corfield 02/12/2003)</i>
         * @return Timestamp when message was last edited.
         */
                public java.sql.Timestamp getEditedTime() {
                  return edited_time;
                }
        /**
         * Sets the time the message was last edited. <p>
         * <i>(WebLearn; A Corfield 02/12/2003)</i>
         * @param t Timestamp when message was last edited.
         */
                public void setEditedTime(java.sql.Timestamp t) {
                  edited_time = t;
                }




    public void setUserId( PrimaryKey key )
	    {
	    user_id = key;
	    }
    public PrimaryKey getUserId()
	    {
        return user_id;
	    }


    public void setAuthorName( String n )
	    {
	    author_name = n;
	    }

    public String getAuthorName()
	    {
        return author_name;
	    }
        /**
         * Sets the name of author at time of edit. <p>
         * <i>(WebLearn; A Corfield 02/12/2003)</i>
         * @param name of author at time of edit.
         */
            public void setEditorName( String name )
                    {
                    editor_name = name;
                    }
        /**
         * Gets the name of author at time of edit. <p>
         * <i>(WebLearn; A Corfield 01/12/2003)</i>
         * @return name of author at time of edit.
         */
            public String getEditorName()
                    {
                return editor_name;
                    }



	public boolean beenSeen()
		{
		return seen;
		}
	public void setSeen( boolean b )
		{
		seen=b;
		}

    
	public boolean isDraft()
		{
		return draft;
		}
	public void setDraft( boolean b )
		{
		draft=b;
		}

    
    public void setSubject( String n )
	    {
	    subject = n;
	    }

    public String getSubject()
	    {
        return subject;
	    }


	public int getStyle()
		{
		return style;
		}
	public void setStyle( int r )
		{
		style=r;
		}


    
    public void setBigStringId( PrimaryKey key )
	    {
	    big_string_id = key;
	    }
    public PrimaryKey getBigStringId()
	    {
        return big_string_id;
	    }


	}