/*
 * Copyright 2004-2006 IDCA. 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.
 * 
 * THIS SOFTWARE IS PROVIDED BY IDCA AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL IDCA OR
 * 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.
 * 
 * The views and conclusions contained in the software and documentation are those of the authors and
 * should not be interpreted as representing official policies, either expressed or implied, of IDCA.
 */

package	com.idcanet.foei.event;

import java.io.Serializable;
import java.util.Collection;

/**
 * An Object that implments thius interface can receive events.<br>
 * Which can be directed at different inputs of the object.<br>
 * 
 * @author Willem Cazander
 * @version 1.0 01/02/2005
 */
public interface EventInput extends Serializable {
	
	/**
	 * Gets the all input EventPorts.<br>
	 * 
	 * @return An List with the current EventPort's.
	 */
	public Collection<EventPort> getInputPorts();
	
	/**
	 * Gets an input EventPort by its name
	 * @param name	The name of the eventPort
	 * @return	Returns an input EventPort by its name
	 */
	public EventPort getInputPort(String name);
	
	/**
	 * Process an Object.<br>
	 * @param inputPort The input channel name of this object.
	 * @param object	The object this input needs to process.
	 */
	public void doEvent(EventPort eventPort,Object object) throws IllegalEventPortNameException;
}