/* ======================================================================
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.math.BigDecimal;
import java.util.Vector;
import java.util.Enumeration;
import java.util.Hashtable;
import java.rmi.RemoteException;
import java.sql.Timestamp;

import org.bodington.database.PrimaryKey;
import org.bodington.server.*;

public interface TextQSession extends BuildingSession 
	{
	public TextQPaper getTextQPaper() throws RemoteException, BuildingServerException;
	
	public void setMaximumMark( int m ) throws RemoteException, BuildingServerException;
	
	public void setGeneralAssessment( int available, BigDecimal weight, String notes ) throws RemoteException, BuildingServerException;
	
	public void setDates( Timestamp open, Timestamp deadline, Timestamp penalty ) throws RemoteException, BuildingServerException;
	
	public Vector getTextQuestionIds() throws RemoteException, BuildingServerException;
	
	public Hashtable getTextQuestions() throws RemoteException, BuildingServerException;
	
	public Vector getTextQuestionsInOrder() throws RemoteException, BuildingServerException;
	
	public Hashtable getStrings() throws RemoteException, BuildingServerException;

	public TextQuestion createQuestion() throws RemoteException, BuildingServerException;
	
	public void removeQuestion( PrimaryKey id ) throws RemoteException, BuildingServerException;
	
	public void changeQuestion( PrimaryKey id, TextQuestion model ) throws RemoteException, BuildingServerException;
	
	public void changeQuestionText( PrimaryKey qid, PrimaryKey tid, String new_text ) throws RemoteException, BuildingServerException;
	
	public boolean canSubmit() throws RemoteException, BuildingServerException;
	public boolean canSubmit( PrimaryKey user_id ) throws RemoteException, BuildingServerException;
	public boolean canSeeMark() throws RemoteException, BuildingServerException;
	public boolean canSeeMark( PrimaryKey user_id ) throws RemoteException, BuildingServerException;
	public String denySubmitMessage() throws RemoteException, BuildingServerException;
	public String denySubmitMessage( PrimaryKey user_id ) throws RemoteException, BuildingServerException;

	public TextQResult record( PrimaryKey[] questionnaire_question_ids, String[] responses ) throws RemoteException, BuildingServerException;
	public TextQResult recordStatus( PrimaryKey entry_id, int status ) throws RemoteException, BuildingServerException;
	public TextQResult recordMarks( PrimaryKey entry_id, PrimaryKey[] text_question_ids, int[] marks, String[] feedback, String general_feedback, String comments ) throws RemoteException, BuildingServerException;
	public TextQResult recordAdjustedMark( PrimaryKey entry_id, int adjusted_mark, String general_feedback, String comments ) throws RemoteException, BuildingServerException;
	
	public TextQResult getTextQResult() throws RemoteException, BuildingServerException;
	public TextQResult getTextQResult( PrimaryKey rid ) throws RemoteException, BuildingServerException;
	public Hashtable getTextQResults() throws RemoteException, BuildingServerException;
	public Vector getTextQUsers() throws RemoteException, BuildingServerException;


	public Hashtable getTextQResponses( PrimaryKey entryid ) throws RemoteException, BuildingServerException;
	
	// returns enumeration of results found and if analysis is non null it is filled in with
	// statistical analysis.
	public Enumeration analyse( String where_clause, TextQAnalysis analysis ) throws RemoteException, BuildingServerException;
	
	}