/*
 * Copyright (c) 2003, Morpho Project.
 * 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. Neither the name of the Morpho Project nor the names of its contributors
 *	  may be used to endorse or promote products derived from this software
 *	  without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 THE COPYRIGHT OWNER 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.
 */
package jp.morpho.webapp;

import java.io.Serializable;

/**
 * <P>
 * Plugin インタフェースは、各プラグインクラスによって実装されます。
 * </P>
 * @author Kenichi Fukuda
 */
public interface Plugin
	extends Serializable
{

	/**
	 * <P>
	 * プラグインを識別するためのキーを返します。
	 * プラグインのキーは、パッケージ名と同じ規則に従う必要があります。
	 * この仕様では、jp.morpho.* に一致する名前を予約しています。
	 * </P>
	 * @return プラグインを識別するためのキー
	 */
	public String getPluginKey();

	/**
	 * <P>
	 * プラグインコンテキストを設定します。
	 * フレームワークでは、プラグインインスタンスが追加された時にこのメソッドを呼び出します。
	 * </P>
	 * @param fc このインスタンスを追加した FrameworkContext オブジェクト
	 * @exception PluginException このメソッドによってスローされ、何らかのエラーが原因で障害が発生したことを示す
	 */
	public void setPluginContext(PluginContext fc)
		throws PluginException;

	/**
	 * <P>
	 * pluginActivate メソッドは、インスタンスが活性化状態になるときに呼び出されます。
	 * この処理でインスタンスを初期化する必要があります。
	 * </P>
	 * @exception PluginException このメソッドによってスローされ、何らかのエラーが原因で障害が発生したことを示す
	 */
	public void pluginActivate()
		throws PluginException;

	/**
	 * <P>
	 * フレームワークでは、プラグインオブジェクトの有効期間を終わらせる前にこのメソッドを呼び出します。
	 * この処理ですべてのリソースを解放する必要があります。
	 * </P>
	 * @exception PluginException このメソッドによってスローされ、何らかのエラーが原因で障害が発生したことを示す
	 */
	public void pluginRemove()
		throws PluginException;

}
