org.seasar.uruma.procedure
インタフェース ProcedureManager

public interface ProcedureManager

プロシジャに関する定義情報を管理するためのインターフェースです。

作成者:

y-komori

メソッドの概要

void	addProcedureDef(String id, Procedures procedures) プロシジャ定義を追加します。
void	getProcedureDef(String id) 指定された画面 ID に対応するプロシジャ定義を取得します。
Procedures	loadProcedureDef(String id, String path) 指定されたパスからプロシジャ定義ファイルを読み込みます。
void	removeProcedureDef(String id) 指定された画面 ID に対応するプロシジャ定義を削除します。
void	writeProcedureDef(Procedures procedures, String path) プロシジャ定義ファイルを書き出します。

メソッドの詳細

addProcedureDef

void addProcedureDef(String id,
                     Procedures procedures)

プロシジャ定義を追加します。

パラメータ:

id - 画面 ID

procedures - プロシジャ定義

removeProcedureDef

void removeProcedureDef(String id)

指定された画面 ID に対応するプロシジャ定義を削除します。

パラメータ:

id - 画面 ID

getProcedureDef

void getProcedureDef(String id)

指定された画面 ID に対応するプロシジャ定義を取得します。

パラメータ:

id - 画面 ID

loadProcedureDef

Procedures loadProcedureDef(String id,
                            String path)

指定されたパスからプロシジャ定義ファイルを読み込みます。
読み込んだプロシジャ定義は、 id で指定された画面 ID と関連づけて保持しますので、あとから getProcedureDef(String) メソッドによって取得することができます。

パラメータ:

path - パス(クラスパス上のパスです。ファイルシステムから読み込む場合は、 file:// をつけて指定してください)

戻り値:

読み込んだプロシジャ定義

writeProcedureDef

void writeProcedureDef(Procedures procedures,
                       String path)
                       throws IOException

プロシジャ定義ファイルを書き出します。

パラメータ:

path - 書き出し先パス

例外:

IOException - ファイルの書き出しに失敗した場合