Package org.iplass.mtp.definition
Interface TypedDefinitionManager<D extends Definition>
-
- Type Parameters:
D- このDefinitionManagerが扱うDefinitionのType
- All Superinterfaces:
Manager
- All Known Subinterfaces:
ActionMappingDefinitionManager,AsyncCommandDefinitionManager,AuthenticationPolicyDefinitionManager,CommandDefinitionManager,EntityDefinitionManager,EntityWebApiDefinitionManager,MailTemplateDefinitionManager,MessageManager,OAuthAuthorizationDefinitionManager,OAuthClientDefinitionManager,OAuthResourceServerDefinitionManager,PreferenceManager,PushNotificationTemplateDefinitionManager,SelectValueDefinitionManager,SmsMailTemplateDefinitionManager,StaticResourceDefinitionManager,TemplateDefinitionManager,TenantManager,UtilityClassDefinitionManager,WebApiDefinitionManager
public interface TypedDefinitionManager<D extends Definition> extends Manager
Definitionの取得、更新を行うための型付けされたManagerのインタフェースです。
-
-
Method Summary
Modifier and Type Method Description DefinitionModifyResultcreate(D definition)新規にDefinitionを作成します。default java.util.List<java.lang.String>definitionList()現在登録されているDefinition名のリストを返します。default java.util.List<DefinitionSummary>definitionSummaryList()現在登録されているDefinitionのDefinitionSummaryのリストをすべて返します。default java.util.List<DefinitionSummary>definitionSummaryList(java.lang.String filterPath)現在登録されているDefinitionのDefinitionSummaryのリストを返します。 再帰的に階層下の定義をすべて取得します。definitionSummaryList(String, boolean)のrecursiveをtrueで呼び出します。java.util.List<DefinitionSummary>definitionSummaryList(java.lang.String filterPath, boolean recursive)現在登録されているDefinitionのDefinitionSummaryのリストを返します。 filterPathが指定された場合は、当該パス以下のDefinitionから取得します。 filterPathがnullもしくは、"/"、""の場合は、すべてのDefinitionから取得します。 recursive=trueが指定された場合は、再帰的に階層下の定義をすべて取得します。Dget(java.lang.String definitionName)指定の定義名のDefinitionを取得します。java.lang.Class<D>getDefinitionType()このTypedDefinitionManagerが扱うDefinitionの型を返却します。DefinitionModifyResultremove(java.lang.String definitionName)指定の定義名のDefinitionを削除します。voidrename(java.lang.String oldDefinitionName, java.lang.String newDefinitionName)指定のDefinitionのnameを変更します。DefinitionModifyResultupdate(D definition)指定のDefinitionで既存のDefinitionを更新します。 (定義名の一致する定義を更新します。)
-
-
-
Method Detail
-
get
D get(java.lang.String definitionName)
指定の定義名のDefinitionを取得します。- Parameters:
definitionName- 定義名- Returns:
- 指定の定義名で一意に特定されるDefinition
-
definitionList
default java.util.List<java.lang.String> definitionList()
現在登録されているDefinition名のリストを返します。- Returns:
- 定義名のリスト
-
definitionSummaryList
default java.util.List<DefinitionSummary> definitionSummaryList()
現在登録されているDefinitionのDefinitionSummaryのリストをすべて返します。- Returns:
- DefinitionSummary(Name, DisplayName, description)のリスト
-
definitionSummaryList
default java.util.List<DefinitionSummary> definitionSummaryList(java.lang.String filterPath)
現在登録されているDefinitionのDefinitionSummaryのリストを返します。 再帰的に階層下の定義をすべて取得します。definitionSummaryList(String, boolean)のrecursiveをtrueで呼び出します。- Parameters:
filterPath- "/"もしくは"."区切りのdefinitionNameのプレフィックス(実装されるDefinitionによりパス区切り文字は異なります)- Returns:
- DefinitionSummary(Name, DisplayName, description)のリスト
-
definitionSummaryList
java.util.List<DefinitionSummary> definitionSummaryList(java.lang.String filterPath, boolean recursive)
現在登録されているDefinitionのDefinitionSummaryのリストを返します。 filterPathが指定された場合は、当該パス以下のDefinitionから取得します。 filterPathがnullもしくは、"/"、""の場合は、すべてのDefinitionから取得します。 recursive=trueが指定された場合は、再帰的に階層下の定義をすべて取得します。- Parameters:
filterPath- "/"もしくは"."区切りのdefinitionNameのプレフィックス(実装されるDefinitionによりパス区切り文字は異なります)recursive- 再帰的に階層下の定義をすべて取得する場合はtrue- Returns:
- DefinitionSummary(Name, DisplayName, description)のリスト
-
create
DefinitionModifyResult create(D definition)
新規にDefinitionを作成します。- Parameters:
definition- 新規に作成するDefinition- Returns:
- 作成結果
-
update
DefinitionModifyResult update(D definition)
指定のDefinitionで既存のDefinitionを更新します。 (定義名の一致する定義を更新します。)- Parameters:
definition- 更新するDefinition- Returns:
- 更新結果
-
remove
DefinitionModifyResult remove(java.lang.String definitionName)
指定の定義名のDefinitionを削除します。- Parameters:
definitionName- 定義名- Returns:
- 削除結果
-
rename
void rename(java.lang.String oldDefinitionName, java.lang.String newDefinitionName)指定のDefinitionのnameを変更します。- Parameters:
oldDefinitionName- 古いnamenewDefinitionName- 新しいname
-
getDefinitionType
java.lang.Class<D> getDefinitionType()
このTypedDefinitionManagerが扱うDefinitionの型を返却します。- Returns:
-
-