Interface TypedDefinitionManager<D extends Definition>

Type Parameters:
D - このDefinitionManagerが扱うDefinitionのType
All Superinterfaces:
Manager
All Known Subinterfaces:
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, WebAuthnDefinitionManager, WebhookEndpointDefinitionManager, WebhookTemplateDefinitionManager

public interface TypedDefinitionManager<D extends Definition> extends Manager
Definitionの取得、更新を行うための型付けされたManagerのインタフェースです。
  • Method Summary

    Modifier and Type
    Method
    Description
    create(D definition)
    新規にDefinitionを作成します。
    default List<String>
    現在登録されているDefinition名のリストを返します。
    現在登録されているDefinitionのDefinitionSummaryのリストをすべて返します。
    現在登録されているDefinitionのDefinitionSummaryのリストを返します。 再帰的に階層下の定義をすべて取得します。 definitionSummaryList(String, boolean)のrecursiveをtrueで呼び出します。
    definitionSummaryList(String filterPath, boolean recursive)
    現在登録されているDefinitionのDefinitionSummaryのリストを返します。 filterPathが指定された場合は、当該パス以下のDefinitionから取得します。 filterPathがnullもしくは、"/"、""の場合は、すべてのDefinitionから取得します。 recursive=trueが指定された場合は、再帰的に階層下の定義をすべて取得します。
    get(String definitionName)
    指定の定義名のDefinitionを取得します。
    このTypedDefinitionManagerが扱うDefinitionの型を返却します。
    remove(String definitionName)
    指定の定義名のDefinitionを削除します。
    void
    rename(String oldDefinitionName, String newDefinitionName)
    指定のDefinitionのnameを変更します。
    update(D definition)
    指定のDefinitionで既存のDefinitionを更新します。 (定義名の一致する定義を更新します。)
  • Method Details

    • get

      D get(String definitionName)
      指定の定義名のDefinitionを取得します。
      Parameters:
      definitionName - 定義名
      Returns:
      指定の定義名で一意に特定されるDefinition
    • definitionList

      default List<String> definitionList()
      現在登録されているDefinition名のリストを返します。
      Returns:
      定義名のリスト
    • definitionSummaryList

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

      default List<DefinitionSummary> definitionSummaryList(String filterPath)
      現在登録されているDefinitionのDefinitionSummaryのリストを返します。 再帰的に階層下の定義をすべて取得します。 definitionSummaryList(String, boolean)のrecursiveをtrueで呼び出します。
      Parameters:
      filterPath - "/"もしくは"."区切りのdefinitionNameのプレフィックス(実装されるDefinitionによりパス区切り文字は異なります)
      Returns:
      DefinitionSummary(Name, DisplayName, description)のリスト
    • definitionSummaryList

      List<DefinitionSummary> definitionSummaryList(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(String definitionName)
      指定の定義名のDefinitionを削除します。
      Parameters:
      definitionName - 定義名
      Returns:
      削除結果
    • rename

      void rename(String oldDefinitionName, String newDefinitionName)
      指定のDefinitionのnameを変更します。
      Parameters:
      oldDefinitionName - 古いname
      newDefinitionName - 新しいname
    • getDefinitionType

      Class<D> getDefinitionType()
      このTypedDefinitionManagerが扱うDefinitionの型を返却します。
      Returns: