Package org.iplass.mtp.definition
Interface DefinitionManager
- All Superinterfaces:
Manager
public interface DefinitionManager extends Manager
DefinitionのManagerです。
Definition共通の詳細なメタデータ(共有設定、バージョン情報、登録状態のチェック)を扱うためのインタフェースを定義します。
-
Method Summary
Modifier and Type Method Description <D extends Definition>
voidcheckState(java.lang.Class<D> type, java.lang.String definitionName)指定のDefinitionの状態をチェックする。 Definitionの状態が不正(設定が不完全などの理由で実行できない)の場合は、 IllegalDefinitionStateExceptionがスローされる<D extends Definition>
DefinitionEntrygetDefinitionEntry(java.lang.Class<D> type, java.lang.String definitionName)指定のDefinitionのDefinition本体およびメタ情報(DefinitionInfo)を取得します。<D extends Definition>
DefinitionEntrygetDefinitionEntry(java.lang.Class<D> type, java.lang.String definitionName, int version)指定のDefinitionの指定バージョンのDefinition本体およびメタ情報(DefinitionInfo)を取得します。<D extends Definition>
DefinitionInfogetInfo(java.lang.Class<D> type, java.lang.String definitionName)指定のDefinitionのメタデータ(DefinitionInfo)を取得します。<D extends Definition>
TypedDefinitionManager<D>getTypedDefinitionManager(java.lang.Class<D> type)型付けされたDefinitionManagerのインスタンスを返します。<D extends Definition>
java.util.List<DefinitionInfo>listInfo(java.lang.Class<D> type, java.lang.String filterPath)DefinitionInfoのリストを取得します。 filterPathにて、取得するリストの範囲を絞り込みが可能です。 filterPathは各Definitionのパス区切り文字("/"もしくは".")にて区切られたパス階層を指定可能です。 パス階層が指定された場合は、その階層以下のDefinitionのDefinitionInfoをリストします。 全件取得する場合は、filterPathはnullもしくは、"/"を指定します。<D extends Definition>
java.util.List<DefinitionSummary>listName(java.lang.Class<D> type, java.lang.String filterPath)DefinitionSummaryのリストを取得します。 filterPathにて、取得するリストの範囲を絞り込みが可能です。 filterPathは各Definitionのパス区切り文字("/"もしくは".")にて区切られたパス階層を指定可能です。 パス階層が指定された場合は、その階層以下のDefinitionのDefinitionSummaryをリストします。 全件取得する場合は、filterPathはnullもしくは、"/"を指定します。 このメソッドは、listName(Class, String, boolean)をrecursive=trueで呼び出した場合と同一です。<D extends Definition>
java.util.List<DefinitionSummary>listName(java.lang.Class<D> type, java.lang.String filterPath, boolean recursive)DefinitionSummaryのリストを取得します。 filterPathにて、取得するリストの範囲を絞り込みが可能です。 filterPathは各Definitionのパス区切り文字("/"もしくは".")にて区切られたパス階層を指定可能です。 パス階層が指定された場合は、その階層以下のDefinitionのDefinitionSummaryをリストします。 全件取得する場合は、filterPathはnullもしくは、"/"、""を指定します。 recursive=falseを指定した場合は、filterPath直下の定義のみを取得します。 recursive=trueの場合は、再帰的にfilterPath階層化すべての定義を取得します。<D extends Definition>
voidrename(java.lang.Class<D> type, java.lang.String oldDefinitionName, java.lang.String newDefinitionName)指定のDefinitionのnameを変更します。<D extends Definition>
voidsetSharedConfig(java.lang.Class<D> type, java.lang.String definitionName, SharedConfig config)指定のDefinitionの共有設定を変更します。
-
Method Details
-
setSharedConfig
<D extends Definition> void setSharedConfig(java.lang.Class<D> type, java.lang.String definitionName, SharedConfig config)指定のDefinitionの共有設定を変更します。- Parameters:
type- 対象のDefinitionのclassインスタンスdefinitionName- Definitionの定義名config- 設定する共有設定
-
getInfo
<D extends Definition> DefinitionInfo getInfo(java.lang.Class<D> type, java.lang.String definitionName)指定のDefinitionのメタデータ(DefinitionInfo)を取得します。- Parameters:
type- 対象のDefinitionのclassインスタンスdefinitionName- Definitionの定義名- Returns:
-
listInfo
<D extends Definition> java.util.List<DefinitionInfo> listInfo(java.lang.Class<D> type, java.lang.String filterPath)DefinitionInfoのリストを取得します。 filterPathにて、取得するリストの範囲を絞り込みが可能です。 filterPathは各Definitionのパス区切り文字("/"もしくは".")にて区切られたパス階層を指定可能です。 パス階層が指定された場合は、その階層以下のDefinitionのDefinitionInfoをリストします。 全件取得する場合は、filterPathはnullもしくは、"/"を指定します。- Parameters:
type- 対象のDefinitionのclassインスタンスfilterPath- "/"区切りのdefinitionNameのプレフィックス(Entity関連の定義は.区切りでも可)- Returns:
-
listName
<D extends Definition> java.util.List<DefinitionSummary> listName(java.lang.Class<D> type, java.lang.String filterPath)DefinitionSummaryのリストを取得します。 filterPathにて、取得するリストの範囲を絞り込みが可能です。 filterPathは各Definitionのパス区切り文字("/"もしくは".")にて区切られたパス階層を指定可能です。 パス階層が指定された場合は、その階層以下のDefinitionのDefinitionSummaryをリストします。 全件取得する場合は、filterPathはnullもしくは、"/"を指定します。 このメソッドは、listName(Class, String, boolean)をrecursive=trueで呼び出した場合と同一です。- Parameters:
type- 対象のDefinitionのclassインスタンスfilterPath- "/"区切りのdefinitionNameのプレフィックス(Entity関連の定義は.区切りでも可)- Returns:
-
listName
<D extends Definition> java.util.List<DefinitionSummary> listName(java.lang.Class<D> type, java.lang.String filterPath, boolean recursive)DefinitionSummaryのリストを取得します。 filterPathにて、取得するリストの範囲を絞り込みが可能です。 filterPathは各Definitionのパス区切り文字("/"もしくは".")にて区切られたパス階層を指定可能です。 パス階層が指定された場合は、その階層以下のDefinitionのDefinitionSummaryをリストします。 全件取得する場合は、filterPathはnullもしくは、"/"、""を指定します。 recursive=falseを指定した場合は、filterPath直下の定義のみを取得します。 recursive=trueの場合は、再帰的にfilterPath階層化すべての定義を取得します。- Parameters:
type- 対象のDefinitionのclassインスタンスfilterPath- "/"区切りのdefinitionNameのプレフィックス(Entity関連の定義は.区切りでも可)- Returns:
-
checkState
<D extends Definition> void checkState(java.lang.Class<D> type, java.lang.String definitionName) throws IllegalDefinitionStateException指定のDefinitionの状態をチェックする。 Definitionの状態が不正(設定が不完全などの理由で実行できない)の場合は、 IllegalDefinitionStateExceptionがスローされる- Parameters:
type- 対象のDefinitionのclassインスタンスdefinitionName- チェック対象のDefinition名- Throws:
IllegalDefinitionStateException
-
getDefinitionEntry
<D extends Definition> DefinitionEntry getDefinitionEntry(java.lang.Class<D> type, java.lang.String definitionName)指定のDefinitionのDefinition本体およびメタ情報(DefinitionInfo)を取得します。- Parameters:
type- 対象のDefinitionのclassインスタンスdefinitionName- 取得対象のDefinition名- Returns:
-
getDefinitionEntry
<D extends Definition> DefinitionEntry getDefinitionEntry(java.lang.Class<D> type, java.lang.String definitionName, int version)指定のDefinitionの指定バージョンのDefinition本体およびメタ情報(DefinitionInfo)を取得します。- Parameters:
type- 対象のDefinitionのclassインスタンスdefinitionName- 取得対象のDefinition名version- 対象のDefinitionのバージョン番号- Returns:
-
rename
<D extends Definition> void rename(java.lang.Class<D> type, java.lang.String oldDefinitionName, java.lang.String newDefinitionName)指定のDefinitionのnameを変更します。- Parameters:
type- 対象のDefinitionのclassインスタンスoldDefinitionName- 変更前のnamenewDefinitionName- 変更後のname
-
getTypedDefinitionManager
<D extends Definition> TypedDefinitionManager<D> getTypedDefinitionManager(java.lang.Class<D> type)型付けされたDefinitionManagerのインスタンスを返します。- Parameters:
type- 対象のDefinitionのclassインスタンス- Returns:
-