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

import org.bodington.server.*;
import org.bodington.sqldatabase.*;
import org.bodington.database.*;
import java.util.Enumeration;


/**
 * This class represents a zone of user administration.  Certain users will be allowed to
 * create users and aliases but only within their own zone.  The code for this user management
 * isn't written so zones seem a little redundant at present.
 * 
 * @author Jon Maber
 * @version 1.0
 */
public class Zone extends org.bodington.sqldatabase.SqlPersistentObject
	{

	/**
	 * The primary key of the zone.
	 */
	private PrimaryKey zone_id;

	/**
	 * A prefix suggested for naming objects associated with this zone.
	 * (E.g. user names)
	 */
	private String prefix;

	/**
	 * The full name of the zone.
	 */
	private String name;
	
	public static Zone findZone( PrimaryKey key )
	    throws BuildingServerException
	    {
	    return (Zone)findPersistentObject( key, "org.bodington.server.realm.Zone" );
	    }
	
	public static Zone findZone( String where )
	    throws BuildingServerException
	    {
	    return (Zone)findPersistentObject( where, "org.bodington.server.realm.Zone" );
	    }
	
	public static Enumeration findZones( String where )
	    throws BuildingServerException
	    {
	    return findPersistentObjects( where, "org.bodington.server.realm.Zone" );
	    }
	

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

    public PrimaryKey getPrimaryKey()
    	{
        return getZoneId();
	    }


    public void setZoneId(PrimaryKey key)
    	{
        zone_id=key;
    	setUnsaved();
    	}

    public PrimaryKey getZoneId()
    	{
        return zone_id;
	    }

	
    public void setPrefix( String p )
    	{
        prefix = p;
    	setUnsaved();
    	}

    public String getPrefix()
    	{
        return prefix;
	    }
	
    public void setName( String n )
    	{
        name =n;
    	setUnsaved();
    	}

    public String getName()
    	{
        return name;
	    }
	
	}