/* ======================================================================
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.assessment;

import java.sql.Timestamp;
import java.util.Enumeration;

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

public class PigeonHoleEntry extends org.bodington.sqldatabase.SqlPersistentObject
	{
	public static final int STATUS_UPLOAD_BY_DATE		=0;
	public static final int STATUS_UPLOAD_CHANGEABLE	=1;
	public static final int STATUS_UPLOAD_LOCKED		=2;
	public static final int STATUS_UPLOAD_PROCESSED		=3;
	public static final int STATUS_UPLOAD_MARKED		=4;
	public static final int STATUS_UPLOAD_RETURNED		=5;
	public static final int STATUS_MAX					=5;
	
	public static final String[] status_message=
		{
		"Date dependent upload.",
		"Permitted to change.",
		"Ready to process.",
		"Processed/processing.",
		"Final mark assigned.",
		"Mark/feedback released."
		};

	
	private PrimaryKey pigeonhole_entry_id;
	private PrimaryKey resource_id;
	private PrimaryKey user_id;
	private PrimaryKey marker_user_id;
	private PrimaryKey uploaded_file_id;
	private PrimaryKey feedback_big_string_id;
	private PrimaryKey comments_big_string_id;
	private int status;
	private Integer mark;
	private Integer adjusted_mark;
	private java.sql.Timestamp when_saved;
	private java.sql.Timestamp when_marked;
	

	
	public static PigeonHoleEntry findPigeonHoleEntry( PrimaryKey key )
	    throws BuildingServerException
	    {
	    return (PigeonHoleEntry)findPersistentObject( key, "org.bodington.server.assessment.PigeonHoleEntry" );
	    }
	
	public static PigeonHoleEntry findPigeonHoleEntry( String where )
	    throws BuildingServerException
	    {
	    return (PigeonHoleEntry)findPersistentObject( where, "org.bodington.assessment.PigeonHoleEntry" );
	    }
	
	public static Enumeration findPigeonHoleEntries( String where )
	    throws BuildingServerException
	    {
	    return findPersistentObjects( where, "org.bodington.assessment.PigeonHoleEntry" );
	    }
	
	public static Enumeration findPigeonHoleEntries( String where, String order )
	    throws BuildingServerException
	    {
	    return findPersistentObjects( where, order, "org.bodington.assessment.PigeonHoleEntry" );
	    }
	
	
    public PrimaryKey getPrimaryKey()
    	{
        return getPigeonHoleEntryId();
    	}

    public void setPrimaryKey(PrimaryKey key)
    	{
    	setPigeonHoleEntryId( key );
    	}


	public PrimaryKey getPigeonHoleEntryId()
		{
		return pigeonhole_entry_id;
		}
		
	public void setPigeonHoleEntryId( PrimaryKey id )
		{
		pigeonhole_entry_id = id;
		}
		
	public PrimaryKey getResourceId()
		{
		return resource_id;
		}
		
	public void setResourceId( PrimaryKey id )
		{
		resource_id = id;
		setUnsaved();
		}


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


	public PrimaryKey getMarkerUserId()
		{
		return marker_user_id;
		}
		
	public void setMarkerUserId( PrimaryKey id )
		{
		marker_user_id = id;
		setUnsaved();
		}


	public PrimaryKey getUploadedFileId()
		{
		return uploaded_file_id;
		}
		
	public void setUploadedFileId( PrimaryKey id )
		{
		uploaded_file_id = id;
		setUnsaved();
		}


	public int getStatus()
		{
		return status;
		}
		
	public void setStatus( int i )
		{
		status = i;
		setUnsaved();
		}
		

	
	public Integer getMark()
		{
		return mark;
		}
		
	public void setMark( Integer i )
		{
		mark = i;
		setUnsaved();
		}
		

	public Integer getAdjustedMark()
		{
		return adjusted_mark;
		}
		
	public void setAdjustedMark( Integer i )
		{
		adjusted_mark = i;
		setUnsaved();
		}
		
		
		
	public PrimaryKey getFeedbackBigStringId()
		{
		return feedback_big_string_id;
		}
		
	public void setFeedbackBigStringId( PrimaryKey s )
		{
		feedback_big_string_id = s;
		setUnsaved();
		}
		
	public String getFeedback()
		throws BuildingServerException
		{
		if ( feedback_big_string_id == null )
			return null;
		BigString bstr = BigString.findBigString( feedback_big_string_id );
		if ( bstr == null )
			return null;
		return bstr.getString();
		}
		
	public void setFeedback( String s )
		throws BuildingServerException
		{
		BigString bstr=null;
		if ( feedback_big_string_id != null )
			bstr = BigString.findBigString( feedback_big_string_id );
		if ( bstr == null )
			{
			bstr = new BigString();
			bstr.setString( s );
			bstr.save();
			feedback_big_string_id = bstr.getBigStringId();
			setUnsaved();
			return;
			}

		bstr.setString( s );
		bstr.save();
		}
	
		
	public PrimaryKey getCommentsBigStringId()
		{
		return comments_big_string_id;
		}
		
	public void setCommentsBigStringId( PrimaryKey s )
		{
		comments_big_string_id = s;
		setUnsaved();
		}
		
	public String getComments()
		throws BuildingServerException
		{
		if ( comments_big_string_id == null )
			return null;
		BigString bstr = BigString.findBigString( comments_big_string_id );
		if ( bstr == null )
			return null;
		return bstr.getString();
		}
		
	public void setComments( String s )
		throws BuildingServerException
		{
		BigString bstr=null;
		if ( comments_big_string_id != null )
			bstr = BigString.findBigString( comments_big_string_id );
		if ( bstr == null )
			{
			bstr = new BigString();
			bstr.setString( s );
			bstr.save();
			comments_big_string_id = bstr.getBigStringId();
			setUnsaved();
			return;
			}

		bstr.setString( s );
		bstr.save();
		}
	
		

		
		
	public Timestamp getWhenSaved()
		{
		return when_saved;
		}
		
	public void setWhenSaved( Timestamp t )
		{
		when_saved = t;
		setUnsaved();
		}
		
	public Timestamp getWhenMarked()
		{
		return when_marked;
		}
		
	public void setWhenMarked( Timestamp t )
		{
		when_marked = t;
		setUnsaved();
		}
		
		
	}