/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.wicket.event;

/**
 * An event
 * 
 * @author Igor Vaynberg (ivaynberg)
 * @param <T>
 *            type of event payload
 */
public interface IEvent<T>
{
	/**
	 * Stops any further broadcast of this event
	 */
	void stop();

	/**
	 * @return true iff event has been stopped.
	 */
	boolean isStop();

	/**
	 * Stops the broadcast of this event any deeper into the hierarchy of the current sink
	 */
	void dontBroadcastDeeper();

	/**
	 * @return type of broadcast that should be used to pass this event on
	 */
	Broadcast getType();

	/**
	 * @return the source of event
	 */
	IEventSource getSource();

	/**
	 * @return payload
	 */
	T getPayload();
}
