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

Function useSearchViewService

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

    Returns {
        deleteEntityByCondition: (
            param: DeleteEntityByConditionParameter,
        ) => Promise<WebApiResponse<BulkDeleteResponse>>;
        deleteEntityByList: (
            param: DeleteEntityByListParameter,
        ) => Promise<WebApiResponse<BulkDeleteResponse>>;
        getRecycleBin: (
            param: GetRecycleBinParameter,
        ) => Promise<WebApiResponse<GetRecycleBinResponse>>;
        loadDefinition: (
            param: LoadSearchViewDefinitionParameter,
        ) => Promise<
            ViewInitializationDataResponse<
                SearchViewDefinition,
                SearchViewAdditionalResponse,
            >,
        >;
        purgeFromRecycleBin: (
            param: PurgeFromRecycleBinParameter,
        ) => Promise<WebApiResponse<PurgeFromRecycleBinResponse>>;
        restoreFromRecycleBin: (
            param: RestoreFromRecycleBinParameter,
        ) => Promise<WebApiResponse<RestoreFromRecycleBinResponse>>;
        searchEntity: (
            param: SearchEntityParameter,
        ) => Promise<WebApiResponse<SearchEntityResponse>>;
        searchForSelection: (
            param: SearchForSelectionParameter,
        ) => Promise<WebApiResponse<SearchEntityResponse>>;
    }

    • deleteEntityByCondition: (
          param: DeleteEntityByConditionParameter,
      ) => Promise<WebApiResponse<BulkDeleteResponse>>
    • deleteEntityByList: (
          param: DeleteEntityByListParameter,
      ) => Promise<WebApiResponse<BulkDeleteResponse>>
    • getRecycleBin: (
          param: GetRecycleBinParameter,
      ) => Promise<WebApiResponse<GetRecycleBinResponse>>
    • loadDefinition: (
          param: LoadSearchViewDefinitionParameter,
      ) => Promise<
          ViewInitializationDataResponse<
              SearchViewDefinition,
              SearchViewAdditionalResponse,
          >,
      >
    • purgeFromRecycleBin: (
          param: PurgeFromRecycleBinParameter,
      ) => Promise<WebApiResponse<PurgeFromRecycleBinResponse>>
    • restoreFromRecycleBin: (
          param: RestoreFromRecycleBinParameter,
      ) => Promise<WebApiResponse<RestoreFromRecycleBinResponse>>
    • searchEntity: (param: SearchEntityParameter) => Promise<WebApiResponse<SearchEntityResponse>>
    • searchForSelection: (
          param: SearchForSelectionParameter,
      ) => 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
型・APIリファレンス
  • Loading...