• Preparing search index...
  • The search index is not available
型・APIリファレンス
  • 型・APIリファレンス
  • useSearchViewService

Function useSearchViewService

  • useSearchViewService(): {
        deleteEntityByCondition: ((param) => Promise<WebApiResponse<BulkDeleteResponse>>);
        deleteEntityByList: ((param) => Promise<WebApiResponse<BulkDeleteResponse>>);
        getRecycleBin: ((param) => Promise<WebApiResponse<GetRecycleBinResponse>>);
        loadDefinition: ((param) => Promise<ViewInitializationDataResponse<SearchViewDefinition, SearchViewAdditionalResponse>>);
        purgeFromRecycleBin: ((param) => Promise<WebApiResponse<PurgeFromRecycleBinResponse>>);
        restoreFromRecycleBin: ((param) => Promise<WebApiResponse<RestoreFromRecycleBinResponse>>);
        searchEntity: ((param) => Promise<WebApiResponse<SearchEntityResponse>>);
        searchForSelection: ((param) => Promise<WebApiResponse<SearchEntityResponse>>);
    }
  • SearchViewのAPIを取り扱うロジックを生成します。

    Returns {
        deleteEntityByCondition: ((param) => Promise<WebApiResponse<BulkDeleteResponse>>);
        deleteEntityByList: ((param) => Promise<WebApiResponse<BulkDeleteResponse>>);
        getRecycleBin: ((param) => Promise<WebApiResponse<GetRecycleBinResponse>>);
        loadDefinition: ((param) => Promise<ViewInitializationDataResponse<SearchViewDefinition, SearchViewAdditionalResponse>>);
        purgeFromRecycleBin: ((param) => Promise<WebApiResponse<PurgeFromRecycleBinResponse>>);
        restoreFromRecycleBin: ((param) => Promise<WebApiResponse<RestoreFromRecycleBinResponse>>);
        searchEntity: ((param) => Promise<WebApiResponse<SearchEntityResponse>>);
        searchForSelection: ((param) => Promise<WebApiResponse<SearchEntityResponse>>);
    }

    • deleteEntityByCondition: ((param) => Promise<WebApiResponse<BulkDeleteResponse>>)
        • (param): Promise<WebApiResponse<BulkDeleteResponse>>
        • 指定された検索条件でEntityを一括削除します。

          Parameters

          • param: DeleteEntityByConditionParameter

            一括削除パラメータ

          Returns Promise<WebApiResponse<BulkDeleteResponse>>

          削除結果

    • deleteEntityByList: ((param) => Promise<WebApiResponse<BulkDeleteResponse>>)
        • (param): Promise<WebApiResponse<BulkDeleteResponse>>
        • 指定されたリストのEntityを一括削除します。

          Parameters

          • param: DeleteEntityByListParameter

            一括削除パラメータ

          Returns Promise<WebApiResponse<BulkDeleteResponse>>

          削除結果

    • getRecycleBin: ((param) => Promise<WebApiResponse<GetRecycleBinResponse>>)
        • (param): Promise<WebApiResponse<GetRecycleBinResponse>>
        • ごみ箱データを取得します。

          Parameters

          • param: GetRecycleBinParameter

            ごみ箱データ取得パラメータ

          Returns Promise<WebApiResponse<GetRecycleBinResponse>>

          ごみ箱データ

    • loadDefinition: ((param) => Promise<ViewInitializationDataResponse<SearchViewDefinition, SearchViewAdditionalResponse>>)
        • (param): Promise<ViewInitializationDataResponse<SearchViewDefinition, SearchViewAdditionalResponse>>
        • SearchView定義をロードします。

          Parameters

          • param: LoadSearchViewDefinitionParameter

            パラメータ

          Returns Promise<ViewInitializationDataResponse<SearchViewDefinition, SearchViewAdditionalResponse>>

          SearchView定義

    • purgeFromRecycleBin: ((param) => Promise<WebApiResponse<PurgeFromRecycleBinResponse>>)
        • (param): Promise<WebApiResponse<PurgeFromRecycleBinResponse>>
        • ごみ箱からのデータの物理削除を行います。

          Parameters

          • param: PurgeFromRecycleBinParameter

            物理削除パラメータ

          Returns Promise<WebApiResponse<PurgeFromRecycleBinResponse>>

          物理削除結果

    • restoreFromRecycleBin: ((param) => Promise<WebApiResponse<RestoreFromRecycleBinResponse>>)
        • (param): Promise<WebApiResponse<RestoreFromRecycleBinResponse>>
        • ごみ箱からの復元を行います。

          Parameters

          • param: RestoreFromRecycleBinParameter

            復元パラメータ

          Returns Promise<WebApiResponse<RestoreFromRecycleBinResponse>>

          復元結果

    • searchEntity: ((param) => Promise<WebApiResponse<SearchEntityResponse>>)
        • (param): Promise<WebApiResponse<SearchEntityResponse>>
        • 指定された条件でEntityを検索します。

          Parameters

          • param: SearchEntityParameter

            Entity検索パラメータ

          Returns Promise<WebApiResponse<SearchEntityResponse>>

          検索結果

    • searchForSelection: ((param) => Promise<WebApiResponse<SearchEntityResponse>>)
        • (param): Promise<WebApiResponse<SearchEntityResponse>>
        • 全選択の対象を検索します。

          Parameters

          • param: SearchForSelectionParameter

            検索パラメータ

          Returns Promise<WebApiResponse<SearchEntityResponse>>

          検索結果

    Example

    const { searchEntity } = Mdc.useSearchViewService();
    searchEntity(
    {
    webApi: 'mdc/entityview/search/search',
    searchCondition: {
    searchType: 'Normal',
    normal: {
    name: '名前'
    },
    detail: {
    conditionList: [
    {
    index: 0,
    property: '',
    conditionalExpression: '',
    value: '',
    },
    ],
    compoundCondition: '',
    compoundConditionalExpression: '',
    },
    fixed: '',
    allVersion: false,
    },
    sortCondition: {
    sortKey: '',
    sortType: 'ASC'
    },
    offset: 0,
    entityName: 'TestEntity',
    viewName: 'DEFAULT'
    })
    .then(({ isSuccess, data }) => {
    console.log(isSuccess);
    if (isSuccess) {
    console.log(data.data);
    console.log(data.count);
    console.log(data.hasNext);
    }
    });

Settings

Member Visibility

Theme

型・APIリファレンス
  • Loading...