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

/**
 * Represents an alternative unique identifier for a specific user.
 * Contains reference to the type of unique identifier (alias_id), the value of
 * the unique identifier (user_alias) and the user it belongs to (user_id).
 * 
 * It's possible that objects of this type will be instantiated mostly when
 * editing values and not so much when searching for users.  Searching for users
 * can be done using a suitable where clause in User.findUsers().  E.g.
 * 
 * Users.findUsers( 
 * "user_id IN (SELECT user_id FROM alias_entries WHERE alias_id = 99 AND user_alias IN ('fred', 'mary, joe'))"
 *  );
 * 
 * The methods are not documented - there are usual methods to find instances from store and
 * methods to set/get properties.
 * 
 * @author Jon Maber
 * @version 1.0
 */
public class AliasEntry extends org.bodington.sqldatabase.SqlPersistentObject
	{

	/**
	 * Primary key of this entry.
	 */
	private PrimaryKey alias_entry_id;

	/**
	 * The type of alias for this entry.
	 */
	private PrimaryKey alias_id;

	/**
	 * The user_id of the user this entry refers to.
	 */
	private PrimaryKey user_id;

	/**
	 * The alias name of the user.
	 */
	private String user_alias;

	public static AliasEntry findAliasEntry( PrimaryKey key )
	    throws BuildingServerException
	    {
	    return (AliasEntry)findPersistentObject( key, "org.bodington.server.realm.AliasEntry" );
	    }
	
	public static AliasEntry findAliasEntry( String where )
	    throws BuildingServerException
	    {
	    return (AliasEntry)findPersistentObject( where, "org.bodington.server.realm.AliasEntry" );
	    }
	
	public static Enumeration findAliasEntries( String where )
	    throws BuildingServerException
	    {
	    return findPersistentObjects( where, "org.bodington.server.realm.AliasEntry" );
	    }
	

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

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

    public void setAliasEntryId( PrimaryKey key )
	    {
	    alias_entry_id = key;
	    setUnsaved();
	    }

    public PrimaryKey getAliasEntryId()
	    {
        return alias_entry_id;
	    }
	

    public void setAliasId( PrimaryKey key )
	    {
	    alias_id = key;
	    setUnsaved();
	    }

    public PrimaryKey getAliasId()
	    {
        return alias_id;
	    }
	
	public void setAlias( Alias a )
		{
		setAliasId( a.getAliasId() );
		}
	public Alias getAlias()
		throws BuildingServerException
		{
		return Alias.findAlias( alias_id );
		}
		
    public void setUserId( PrimaryKey key )
	    {
	    user_id = key;
	    setUnsaved();
	    }

    public PrimaryKey getUserId()
	    {
        return user_id;
	    }
	
	public void setUser( User u )
		{
		setUserId( u.getUserId() );
		}
	public User getUser()
		throws BuildingServerException
		{
		return User.findUser( user_id );
		}
		
    public void setUserAlias( String n )
	    {
	    user_alias = n;
	    setUnsaved();
	    }

    public String getUserAlias()
	    {
        return user_alias;
	    }

	}