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

/**
* EOFaultHandler defines the contract for objects that can
* create and populate faults.  In wotonomy, this interface is
* currently only a marker interface.
*
* @author michael@mpowers.net
* @author $Author: cgruber $
* @version $Revision: 893 $
*/
public abstract class EOFaultHandler {

	protected Class _targetClass;

	public EOFaultHandler() {
		super();
	}

	public static EOFaultHandler handlerForFault(Object obj) {
		if (!(obj instanceof EOFaulting))
			throw new IllegalArgumentException("Object must implement EOFaulting");
		return ((EOFaulting)obj).faultHandler();
	}

	public static boolean isFault(Object obj) {
		if (obj == null)
			return false;
		boolean isit = (obj instanceof EOFaulting);
		if (isit)
			isit = ((EOFaulting)obj).isFault();
		return isit;
	}

	public static void makeObjectIntoFault(Object obj, EOFaultHandler handler) {
		if (!(obj instanceof EOFaulting))
			throw new IllegalArgumentException("Object must implement EOFaulting");
		((EOFaulting)obj).turnIntoFault(handler);
	}

	public static void clearFault(Object obj) {
		if (!(obj instanceof EOFaulting))
			throw new IllegalArgumentException("Object must implement EOFaulting");
		((EOFaulting)obj).clearFault();
	}

	public Class targetClass() {
		return _targetClass;
	}

	public Object createFaultForDeferredFault(Object fault, EOEnterpriseObject source) {
		return fault;
	}

	public String descriptionForObject(Object obj) {
		if (obj == null)
			return "<null>";
		return obj.toString();
	}

	public String eoShallowDescription(Object obj) {
		return null;
	}

	public abstract void completeInitializationOfObject(Object obj);

	public abstract void faultWillFire(Object obj);

}

/*
 * $Log$
 * Revision 1.1  2006/02/16 13:19:57  cgruber
 * Check in all sources in eclipse-friendly maven-enabled packages.
 *
 * Revision 1.2  2003/08/19 01:53:12  chochos
 * EOObjectStore had some incompatible return types (Object instead of EOEnterpriseObject, in fault methods mostly). It's internally consistent but I hope it doesn't break anything based on this, even though fault methods mostly throw exceptions for now.
 *
 * Revision 1.1  2001/11/13 04:13:59  mpowers
 * Added interfaces needed to begin work on EOCustomObject.
 *
 */