パッケージ org.iplass.mtp.definition

インタフェース TypedDefinitionManager<D extends Definition>

型パラメータ:
D - このDefinitionManagerが扱うDefinitionのType
すべてのスーパーインタフェース:
Manager
既知のサブインタフェースのリスト:
ActionMappingDefinitionManager, AsyncCommandDefinitionManager, AuthenticationPolicyDefinitionManager, CommandDefinitionManager, EntityCalendarManager, EntityDefinitionManager, EntityFilterManager, EntityViewManager, EntityWebApiDefinitionManager, MailTemplateDefinitionManager, MenuItemManager, MenuTreeManager, MessageManager, OAuthAuthorizationDefinitionManager, OAuthClientDefinitionManager, OAuthResourceServerDefinitionManager, OpenIdConnectDefinitionManager, PreferenceManager, PushNotificationTemplateDefinitionManager, SelectValueDefinitionManager, SmsMailTemplateDefinitionManager, StaticResourceDefinitionManager, TemplateDefinitionManager, TenantManager, TopViewDefinitionManager, TreeViewManager, UtilityClassDefinitionManager, WebApiDefinitionManager, WebhookEndpointDefinitionManager, WebhookTemplateDefinitionManager
public interface TypedDefinitionManager<D extends Definition>
extends Manager
Definitionの取得、更新を行うための型付けされたManagerのインタフェースです。

  • メソッドの概要

    修飾子とタイプ メソッド 説明
    DefinitionModifyResult create​(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のリストを返します。
    java.util.List<DefinitionSummary> definitionSummaryList​(java.lang.String filterPath, boolean recursive)
    現在登録されているDefinitionのDefinitionSummaryのリストを返します。
    D get​(java.lang.String definitionName)
    指定の定義名のDefinitionを取得します。
    java.lang.Class<D> getDefinitionType()
    このTypedDefinitionManagerが扱うDefinitionの型を返却します。
    DefinitionModifyResult remove​(java.lang.String definitionName)
    指定の定義名のDefinitionを削除します。
    void rename​(java.lang.String oldDefinitionName, java.lang.String newDefinitionName)
    指定のDefinitionのnameを変更します。
    DefinitionModifyResult update​(D definition)
    指定のDefinitionで既存のDefinitionを更新します。

  • メソッドの詳細

    • get

      D get​(java.lang.String definitionName)
      指定の定義名のDefinitionを取得します。
      パラメータ:
      definitionName - 定義名
      戻り値:
      指定の定義名で一意に特定されるDefinition

    • definitionList

      default java.util.List<java.lang.String> definitionList()
      現在登録されているDefinition名のリストを返します。
      戻り値:
      定義名のリスト

    • definitionSummaryList

      default java.util.List<DefinitionSummary> definitionSummaryList()
      現在登録されているDefinitionのDefinitionSummaryのリストをすべて返します。
      戻り値:
      DefinitionSummary(Name, DisplayName, description)のリスト

    • definitionSummaryList

      default java.util.List<DefinitionSummary> definitionSummaryList​(java.lang.String filterPath)
      現在登録されているDefinitionのDefinitionSummaryのリストを返します。 再帰的に階層下の定義をすべて取得します。 definitionSummaryList(String, boolean)のrecursiveをtrueで呼び出します。
      パラメータ:
      filterPath - "/"もしくは"."区切りのdefinitionNameのプレフィックス（実装されるDefinitionによりパス区切り文字は異なります）
      戻り値:
      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が指定された場合は、再帰的に階層下の定義をすべて取得します。
      パラメータ:
      filterPath - "/"もしくは"."区切りのdefinitionNameのプレフィックス（実装されるDefinitionによりパス区切り文字は異なります）
      recursive - 再帰的に階層下の定義をすべて取得する場合はtrue
      戻り値:
      DefinitionSummary(Name, DisplayName, description)のリスト

    • create

      DefinitionModifyResult create​(D definition)
      新規にDefinitionを作成します。
      パラメータ:
      definition - 新規に作成するDefinition
      戻り値:
      作成結果

    • update

      DefinitionModifyResult update​(D definition)
      指定のDefinitionで既存のDefinitionを更新します。 （定義名の一致する定義を更新します。）
      パラメータ:
      definition - 更新するDefinition
      戻り値:
      更新結果

    • remove

      DefinitionModifyResult remove​(java.lang.String definitionName)
      指定の定義名のDefinitionを削除します。
      パラメータ:
      definitionName - 定義名
      戻り値:
      削除結果

    • rename

      void rename​(java.lang.String oldDefinitionName, java.lang.String newDefinitionName)
      指定のDefinitionのnameを変更します。
      パラメータ:
      oldDefinitionName - 古いname
      newDefinitionName - 新しいname

    • getDefinitionType

      java.lang.Class<D> getDefinitionType()
      このTypedDefinitionManagerが扱うDefinitionの型を返却します。
      戻り値: