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

インタフェース EntityDefinitionManager

すべてのスーパーインタフェース:
Manager, TypedDefinitionManager<EntityDefinition>
public interface EntityDefinitionManager extends TypedDefinitionManager<EntityDefinition>
Entity定義を管理するクラスのインタフェース。

  • メソッドの詳細

    • create

      EntityDefinitionModifyResult create(EntityDefinition definition)
      新規にEntity定義を作成する。
      定義:
      create インタフェース内 TypedDefinitionManager<EntityDefinition>
      パラメータ:
      definition - 新規に作成するEntityの定義
      戻り値:
      作成結果

    • get

      EntityDefinition get(String definitionName)
      指定の定義名のEntity定義を取得する。
      定義:
      get インタフェース内 TypedDefinitionManager<EntityDefinition>
      パラメータ:
      definitionName - 定義名
      戻り値:
      指定の定義名で一意に特定されるEntity定義

    • definitionList

      List<String> definitionList()
      現在登録されているEntity定義名のリストを返す。
      定義:
      definitionList インタフェース内 TypedDefinitionManager<EntityDefinition>
      戻り値:
      Entity定義名のリスト

    • definitionNameList

      List<DefinitionSummary> definitionNameList()
      現在登録されているEntity定義名のリストを返す。
      戻り値:
      Entity定義名(Name, DisplayName, Description)のリスト

    • definitionNameList

      List<DefinitionSummary> definitionNameList(String filterPath)
      現在登録されているEntity定義名のリストを返す。
      パラメータ:
      filterPath - "/"区切りのdefinitionNameのプレフィックス（Entity関連の定義は.区切りでも可）
      戻り値:
      Entity定義名(Name, DisplayName, Description)のリスト

    • remove

      EntityDefinitionModifyResult remove(String definitionName)
      指定の定義名のEntityを削除する。
      定義:
      remove インタフェース内 TypedDefinitionManager<EntityDefinition>
      パラメータ:
      definitionName - 定義名
      戻り値:
      削除結果

    • update

      EntityDefinitionModifyResult update(EntityDefinition definition)
      指定のEntity定義で既存の定義を更新する。 （定義名の一致する定義を更新する。）
      定義:
      update インタフェース内 TypedDefinitionManager<EntityDefinition>
      パラメータ:
      definition - 更新するEntity定義
      戻り値:
      更新結果

    • update

      EntityDefinitionModifyResult update(EntityDefinition definition, Map<String,String> renamePropertyMap)
      指定のEntity定義で既存の定義を更新する。 （定義名の一致する定義を更新する。）
      パラメータ:
      definition - 更新するEntity定義
      renamePropertyMap - 名前を変更するプロパティのMap(from, to)
      戻り値:
      更新結果

    • getAutoNumberCurrentValue

      long getAutoNumberCurrentValue(String definitionName, String propertyName)
      AutoNumberPropertyの現在のカウンター値を返す。
      パラメータ:
      definitionName - Entity定義名
      propertyName - AutoNumberProperty型プロパティのプロパティ名
      戻り値:
      現在のカウンター値

    • getAutoNumberCurrentValueList

      List<org.apache.commons.lang3.tuple.Pair<String,Long>> getAutoNumberCurrentValueList(String definitionName, String propertyName)
      AutoNumberPropertyの現在のカウンター値のリストを返す。
      パラメータ:
      definitionName - Entity定義名
      propertyName - AutoNumberProperty型プロパティのプロパティ名
      戻り値:
      現在のカウンター値のリスト

    • getAutoNumberCurrentValue

      long getAutoNumberCurrentValue(String definitionName, String propertyName, String subUnitKey)
      AutoNumberPropertyの現在のカウンター値を返す。
      パラメータ:
      definitionName - Entity定義名
      propertyName - AutoNumberProperty型プロパティのプロパティ名
      subUnitKey - 採番単位のKEY値
      戻り値:
      現在のカウンター値

    • resetAutoNumberCounter

      void resetAutoNumberCounter(String definitionName, String propertyName, long startsWith)
      AutoNumberPropertyのカウンター値を指定の値にリセットする。
      パラメータ:
      definitionName - Entity定義名
      propertyName - AutoNumberProperty型プロパティのプロパティ名
      subUnitKey - 採番単位のKEY値
      startsWith - リセットするカウンター値

    • resetAutoNumberCounter

      void resetAutoNumberCounter(String definitionName, String propertyName, String subUnitKey, long startsWith)
      AutoNumberPropertyのカウンター値を指定の値にリセットする。
      パラメータ:
      definitionName - Entity定義名
      propertyName - AutoNumberProperty型プロパティのプロパティ名
      subUnitKey - 採番単位のKEY値
      startsWith - リセットするカウンター値

    • renameEntityDefinition

      void renameEntityDefinition(String from, String to)
      Entity定義名を変更する。 データ自体はそのまま保持される。
      パラメータ:
      from - 変更前の定義名
      to - 変更後の定義名

    • renamePropertyDefinition

      void renamePropertyDefinition(String definitionName, String from, String to)
      Entity定義のプロパティ名を変更する。 データ自体はそのまま保持される。
      パラメータ:
      definitionName - 対象のEntity定義名
      from - 変更前のプロパティ名
      to - 変更後のプロパティ名

    • getStorageSpaceList

      List<String> getStorageSpaceList()
      現在登録されているEntity Storage Spaceのリストを返す。
      戻り値:
      Entity Entity Storage Spaceのリスト

    • isLockedSchema

      boolean isLockedSchema(String definitionName)

      スキーマがロックされているかを返す。

      パラメータ:
      definitionName - 対象のEntity定義名
      戻り値:
      true：ロック