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

import java.awt.Color;
import java.util.Vector;
import java.util.zip.*;

import org.bodington.server.BuildingServerException;
import org.bodington.database.PrimaryKey;
import org.bodington.server.resources.*;
import org.bodington.xml.XMLQuery;
/**
 * Represents a user's session with the site.  Subclasses may represent
 * a session with a specific resource or a navigating session that can change
 * its currently selected resource.  Contains methods appropriate to all
 * types of session.
 * 
 * @author Jon Maber
 * @version 1.0
 */
public interface BuildingSession
	{
        
    public void init( PrimaryKey user_id, PrimaryKey resource_id )
    throws BuildingServerException;

    public PrimaryKey getResourceId() throws BuildingServerException;
    public void setResourceId(PrimaryKey resourceId) throws  BuildingServerException;
    public PrimaryKey getUserId() throws BuildingServerException;
    public void setUserId(PrimaryKey userId) throws BuildingServerException;
    
    /**
     * Set the ID of the current resource for this session. 
     * @param k the ID of the resource for this instance.
     * @throws BuildingServerException
     */
    public void setResource( PrimaryKey k ) throws BuildingServerException;

    /**
     * Set the current resource for this session. 
     * @param resource the the resource for this instance.
     * @throws BuildingServerException
     * @see #setResource(PrimaryKey)
     */
    public void setResource( Resource resource ) throws
        BuildingServerException;
		
    public long getPropertiesLastModifiedTime()
        throws BuildingServerException;
    
    public void unspecifyProperty( String name )
        throws BuildingServerException;
    public void specifyProperty( String name, String value )
        throws BuildingServerException;
    
    public String getSpecifiedProperty( String name )
        throws BuildingServerException;
    
    public String getProperty( String name )
        throws BuildingServerException;
    public String getProperty( String name, String def )
    	throws BuildingServerException;
    
    public Color getPropertyColor( String name )
        throws BuildingServerException;
    public Color getPropertyColor( String name, Color def )
        throws BuildingServerException;

	
    public PrimaryKey getStyleResourceId()
        throws BuildingServerException;
    public String[] getStyleResourcePath()
        throws BuildingServerException;
    
 	public String getNameOfUser( PrimaryKey uid )
		throws BuildingServerException;
		
    public void parseManifest()
		throws BuildingServerException;

	public void generateImsManifest()
		throws BuildingServerException;
	
	public void generateFileListing()
		throws BuildingServerException;

	public int importMetadata( String file_name )
		throws BuildingServerException;
		
	public String exportMetadata()
		throws BuildingServerException;
	
	public Vector searchMetadata( XMLQuery query )
		throws BuildingServerException;
	
	public String[] getFieldValuesFromMetadata( String elementName )
	    throws BuildingServerException;
	
	public void updateBasicMetadata( String title, String description )
		throws BuildingServerException;
	
	public void updateMetaDataTitleField( String text, String languageCode );
	
	public void updateMetadataDescriptionField( String text, String languageCode );
	
	public void updateMetadataAuthorField( String authorName, String contactDetails );
	
	public void updateMetadataEditorField( String editorName, String contactDetails );
	
	public void updateMetadataContributorField( String roleName, String contributorName, String contactDetails, String languageCode );

	public void updateMetadataKeywords( String[] keywords, String languageCode );
	
	/**
	 * Not sure if this is the right place for this.... It depends on uploaded files.
	 */
	public void importImsPackage( String url, boolean parentacl, String zipfile )
		throws BuildingServerException;

		
	public Menu getResourceMenu()
		throws BuildingServerException;

	public void generateResourceMenu()
		throws BuildingServerException;

	public String transferResourceMenu( String current_pathname )
		throws BuildingServerException;
	
	public UploadedFileSession getUploadedFileSession()
		throws BuildingServerException;
    
    /**
     * Checks the names of resources at this level. If the requested name
     * for the new resource already exists, the requested name is modified
     * by appending a number (and is truncated if necessary).
     * @param url The requested name
     * @return newName A name that is not is use at this location
     */
    public String findUniqueName(String url) throws BuildingServerException;

    /**
     * Find the resource quota for the current resource. Includes all child 
     * resources that don't have their own quota set.
     * @return The quota for the current resource, <code>null</code> if there
     * isn't a quota.
     */
    public Quota getQuota() throws BuildingServerException;
    
    /**
     * Set the Resources quota for the current resource.
     * @param quota The quota limit.
     * @throws BuildingServerException If there is a problem setting the quota
     * for example the resource doesn't already have a quota set and has children.
     * @throws PermissionDeniedException If the current user doesn't have
     * permission to set the quota.
     */
    public void setQuota(long quota) throws BuildingServerException;
    
    public void invalidateCache() throws BuildingServerException;
    
	}