/* ======================================================================
   Parts Copyright 2006 University of Leeds, Oxford University, University of the Highlands and Islands.

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

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

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
	

    private java.sql.Timestamp edited_time;         //time this message was last edited.
    
	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.
     * @return Timestamp when message was last edited.
     */
    public java.sql.Timestamp getEditedTime()
        {
        return edited_time;
        }

    /**
     * Sets the time the message was last edited.
     * @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.
     * @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.
     * @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;
	    }


	}
