/*
Wotonomy: OpenStep design patterns for pure Java applications.
Copyright (C) 2001 Michael Powers

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library; if not, see http://www.gnu.org
*/

package net.wotonomy.control;

/**
 * EORelationshipManipulation provides methods for generically adding and
 * removing relationships between objects, handling both one-way and reciprocal
 * relationships.
 *
 * @author michael@mpowers.net
 * @author $Author: cgruber $
 * @version $Revision: 893 $
 */
public interface EORelationshipManipulation {
	/**
	 * Adds the specified object to the relationship on this object specified by the
	 * key. For to-one relationships, this operation is the same as valueForKey.
	 */
	void addObjectToPropertyWithKey(Object anObject, String aKey);

	/**
	 * Removes the specified object from the relationship on this object specified
	 * by the key. For to-one relationships, this operation is the same as
	 * takeValueForKey with a null value.
	 */
	void removeObjectFromPropertyWithKey(Object anObject, String aKey);

	/**
	 * As addObjectToProperty with key, but also performs the reciprocal operation
	 * on the other side of the relationship.
	 */
	void addObjectToBothSidesOfRelationshipWithKey(EORelationshipManipulation anObject, String aKey);

	/**
	 * As removeObjectFromPropertyWithKey with key, but also performs the reciprocal
	 * operation on the other side of the relationship.
	 */
	void removeObjectFromBothSidesOfRelationshipWithKey(EORelationshipManipulation anObject, String aKey);

}

/*
 * $Log$ Revision 1.1 2006/02/16 13:19:57 cgruber Check in all sources in
 * eclipse-friendly maven-enabled packages.
 *
 * Revision 1.1 2001/11/13 04:13:59 mpowers Added interfaces needed to begin
 * work on EOCustomObject.
 *
 *
 */