/*
このファイルの中身は、NTT オープンソースライセンス　バージョン 1.0（「本
契約」という）の適用を受けます。
本契約を遵守しない限り、このファイルを使用してはなりません。
本契約のコピーは、次のＵＲＬから入手できます。
【配布サイトのURL】 http://www.oss.ecl.ntt.co.jp/lms/

本契約に基づき頒布されるソフトウェアは、現状のまま、明示又は黙示のあらゆ
る種類の保証なしで、頒布されます。本契約に基づく権利及び制限を律する特定
の文言については、本契約を参照してください。

「オリジナルコード」は、 NTT Cyber Space Laboratories Code です。 
「オリジナルコード」の「初期開発者」は、日本電信電話株式会社です。  
日本電信電話株式会社により創作された部分は、Copyright (C) 2004 
日本電信電話株式会社 です。
全ての権利が留保されます。 
「コントリビュータ」：_____________________________________ 


The contents of this file are subject to the NTT Opensource License
Version 1.0 (the License); you may not use this file except in
compliance with the License. You may obtain a copy of the License at
【配布サイトのURL】 http://www.oss.ecl.ntt.co.jp/lms/

Software distributed under the License is distributed on an AS IS
basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
License for the specific language governing rights and limitations
under the License.

The Original Code is NTT Cyber Space Laboratories Code .

The Initial Developer of the Original Code is NIPPON TELEGRAPH AND 
TELEPHONE CORPORATION.
Portions created by the NIPPON TELEGRAPH AND TELEPHONE CORPORATION 
are Copyright (C) 2004 NIPPON TELEGRAPH AND TELEPHONE CORPORATION. 
All Rights Reserved.

Contributor(s) ______________________________________.
*/

//
// 画面情報取得アクション基底クラス
// 
//	変更履歴
//	2004/01/08 新規作成	T.Nishiki
//
package jp.co.ntt.lms.xms.framework;

import jp.co.ntt.lms.xmo.util.DebugLog;

/**
 * 画面情報取得アクション基底クラス。<BR>
 * ＪＳＰなどで画面表示するデータを取得するロジックを作成する。<BR>
 * @author T.Nishiki
 */
public abstract class XmsScreenAction {
	
	/**
	 * リクエスト処理初期化メソッド<BR>
	 * 各HTTPリクエストの処理を行う場合の初期化処理を実装する。
	 * @param xmsRequest リクエスト・オブジェクト。<br>
	 * @param xmsResponse レスポンス・オブジェクト。<br>
	 * @exception XmsException 処理中に例外が発生した場合
	 */
	protected abstract void initProcessRequest( XmsRequest xmsRequest, XmsResponse xmsResponse )
		throws XmsException;

	/**
	 * リクエストを処理するためのビジネスロジック実行メソッド<BR>
	 * 各リクエストごとにビジネスロジックを実装する。
	 * @param xmsRequest リクエスト・オブジェクト。<br>
	 * @param xmsResponse レスポンス・オブジェクト。<br>
	 * @exception XmsException 処理中に例外が発生した場合
	 */
	protected abstract void processRequest( XmsRequest xmsRequest, XmsResponse xmsResponse )
		throws XmsException;

	/**
	 * フレームワークから実行されるメソッド。<BR>
	 * 初期化メソッド、実行メソッドをコールする。<BR>
	 * @param xmsRequest リクエスト・オブジェクト。<br>
	 * @param xmsResponse レスポンス・オブジェクト。<br>
	 * @exception XmsException 処理中に例外が発生した場合
	 */
	public final void perform( XmsRequest xmsRequest, XmsResponse xmsResponse )
		throws XmsException
	{
		try {
			// 初期化処理
			initProcessRequest( xmsRequest, xmsResponse );

			// 業務処理のコール
			processRequest( xmsRequest, xmsResponse );

		} catch ( XmsException e ) {
			DebugLog.write( this.getClass(), e, DebugLog.HIGHT );
			throw e;
		} catch( Exception e ) {
			DebugLog.write( this.getClass(), e, DebugLog.HIGHT );
			throw new XmsSystemException(e);
		}
	}

	/**
	 * 検索結果をＣＳＶ文字列に変換する。<br>
	 * このクラスでは空文字列（&quot;&quot;）を戻すように定義する。
	 * サブクラスにて適宜修正する。
	 * 
	 * @param result 検索結果。
	 * @return ＣＳＶ文字列。
	 */
	public String convertToCSV( XmsScreenBean result ) 
			throws XmsException {
		return "";
	}
	
	/**
	 * ダウンロードダイアログに初期表示するファイル名を戻す。<br>
	 * フレームワークは、ファイルをクライアントにダウンロードするように動作する場合、
	 * ファイル名欄に初期表示する文字列を、このメソッドの戻り値を利用する。
	 * このメソッドからnullまたは空文字列（&quot;&quot;）が戻った場合、
	 * フレームワークが定める命名規則に従って決定する。
	 * このクラスではnullを戻すように定義するので、
	 * 独自の命名規則がある場合は、適宜オーバライドする。
	 * 
	 * @return 決定したファイル名。
	 */
	public String getDownloadFileName(XmsRequest xmsRequest, XmsResponse xmsResponse)
			throws XmsException {
		return null;
	}
}
