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

/**
 * Records the membership of a User within a Group.  Contains no
 * serious code.  There are "find" methods and property get/set
 * methods.
 * 
 * @author Jon Maber
 * @version 1.0
 */
public class Member extends org.bodington.sqldatabase.SqlPersistentObject
	{

	/**
	 * A unique primary key for this membership entry.
	 */
	private PrimaryKey member_id;

	/**
	 * The id of the group that the user belongs to.
	 */
	private PrimaryKey group_id;

	/**
	 * The id of the user that belongs to the group.
	 */
	private PrimaryKey user_id;
	
	private MemberIndexKey[] ikeys;

	public static Member findMember( PrimaryKey key )
	    throws BuildingServerException
	    {
	    return (Member)findPersistentObject( key, "org.bodington.server.realm.Member" );
	    }
	
	public static Member findMemberByUserIdAndGroupId( PrimaryKey user_id, PrimaryKey group_id )
	    throws BuildingServerException
	    {
	    MemberIndexKey ikey = new MemberIndexKey();
	    ikey.setUserId( user_id );
	    ikey.setGroupId( group_id );
	    return (Member)findPersistentObject( ikey, "org.bodington.server.realm.Member" );
	    }
	
	public static Member findMember( String where )
	    throws BuildingServerException
	    {
	    return (Member)findPersistentObject( where, "org.bodington.server.realm.Member" );
	    }
	
	public static Enumeration findMembers( String where )
	    throws BuildingServerException
	    {
	    return findPersistentObjects( where, "org.bodington.server.realm.Member" );
	    }
	
	public Member()
		{
		ikeys = new MemberIndexKey[1];
		ikeys[0] = new MemberIndexKey();
		}

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

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

    public void setMemberId(PrimaryKey key)
    	{
    	member_id = key;
    	setUnsaved();
    	}

    public PrimaryKey getMemberId()
    	{
    	return member_id;
	    }

    public void setGroupId(PrimaryKey key)
    	{
    	group_id = key;
    	setUnsaved();
    	ikeys[0].setGroupId( key );
    	}

    public PrimaryKey getGroupId()
    	{
    	return group_id;
	    }

    public void setUserId(PrimaryKey key)
    	{
    	user_id = key;
    	setUnsaved();
    	ikeys[0].setUserId( key );
    	}

    public PrimaryKey getUserId()
    	{
    	return user_id;
	    }

    public void setGroup( Group g )
    	{
    	setGroupId( g.getGroupId() );
    	}

    public Group getGroup()
        throws BuildingServerException
    	{
		return Group.findGroup( group_id );
	    }

    public void setUser( User u )
    	{
    	setUserId( u.getUserId() );
    	}

    public User getUser()
        throws BuildingServerException
    	{
		return User.findUser( user_id );
	    }
	
	public IndexKey[] getIndexKeys()
	    {
	    
	    if ( ikeys[0].getGroupId() == null || ikeys[0].getUserId() == null)
	        return null;

	    return ikeys;
	    }
	    
	public boolean matchesKey( IndexKey testikey )
	    {
	    return testikey.equals( ikeys[0] );
	    }
	
	}