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

Function useDetailViewService

  • useDetailViewService(): {
        deleteEntity: ((param) => Promise<WebApiResponse<DeleteEntityResponse>>);
        getAuditLogList: ((param) => Promise<WebApiResponse<GetAuditLogResponse>>);
        getReferenceAuditLogList: ((param) => Promise<WebApiResponse<GetReferenceAuditLogResponse>>);
        getVersionList: ((param) => Promise<WebApiResponse<GetVersionListResponse>>);
        loadDefinition: ((param) => Promise<ViewInitializationDataResponse<DetailViewDefinition, DetailViewLoadAdditionalResponse>>);
        lockEntity: ((param) => Promise<WebApiResponse<LockEntityResponse>>);
        saveEntity: ((param) => Promise<WebApiResponse<SaveEntityResponse>>);
        startWorkflowProcess: ((param) => Promise<WebApiResponse<StartWorkflowProcessResponse>>);
        unlockEntity: ((param) => Promise<WebApiResponse<LockEntityResponse>>);
        uploadFile: ((param) => Promise<WebApiResponse<UploadFileResponse>>);
    }
  • DetailViewのAPIを取り扱うロジックを生成します。

    Returns {
        deleteEntity: ((param) => Promise<WebApiResponse<DeleteEntityResponse>>);
        getAuditLogList: ((param) => Promise<WebApiResponse<GetAuditLogResponse>>);
        getReferenceAuditLogList: ((param) => Promise<WebApiResponse<GetReferenceAuditLogResponse>>);
        getVersionList: ((param) => Promise<WebApiResponse<GetVersionListResponse>>);
        loadDefinition: ((param) => Promise<ViewInitializationDataResponse<DetailViewDefinition, DetailViewLoadAdditionalResponse>>);
        lockEntity: ((param) => Promise<WebApiResponse<LockEntityResponse>>);
        saveEntity: ((param) => Promise<WebApiResponse<SaveEntityResponse>>);
        startWorkflowProcess: ((param) => Promise<WebApiResponse<StartWorkflowProcessResponse>>);
        unlockEntity: ((param) => Promise<WebApiResponse<LockEntityResponse>>);
        uploadFile: ((param) => Promise<WebApiResponse<UploadFileResponse>>);
    }

    • deleteEntity: ((param) => Promise<WebApiResponse<DeleteEntityResponse>>)
        • (param): Promise<WebApiResponse<DeleteEntityResponse>>
        • Entityデータを削除します。

          Parameters

          • param: DeleteEntityParameter

            パラメータ

          Returns Promise<WebApiResponse<DeleteEntityResponse>>

          削除結果

    • getAuditLogList: ((param) => Promise<WebApiResponse<GetAuditLogResponse>>)
        • (param): Promise<WebApiResponse<GetAuditLogResponse>>
        • Entityの操作ログを取得します。

          Parameters

          • param: GetAuditLogParameter

            パラメータ

          Returns Promise<WebApiResponse<GetAuditLogResponse>>

          操作ログ

    • getReferenceAuditLogList: ((param) => Promise<WebApiResponse<GetReferenceAuditLogResponse>>)
        • (param): Promise<WebApiResponse<GetReferenceAuditLogResponse>>
        • 参照先のEntityの操作ログを取得します。

          Parameters

          • param: GetReferenceAuditLogParameter

            パラメータ

          Returns Promise<WebApiResponse<GetReferenceAuditLogResponse>>

          参照先のEntityの操作ログ

    • getVersionList: ((param) => Promise<WebApiResponse<GetVersionListResponse>>)
        • (param): Promise<WebApiResponse<GetVersionListResponse>>
        • Entityバージョン情報を取得します。

          Parameters

          • param: GetVersionListParameter

            パラメータ

          Returns Promise<WebApiResponse<GetVersionListResponse>>

          Entityバージョン情報

    • loadDefinition: ((param) => Promise<ViewInitializationDataResponse<DetailViewDefinition, DetailViewLoadAdditionalResponse>>)
        • (param): Promise<ViewInitializationDataResponse<DetailViewDefinition, DetailViewLoadAdditionalResponse>>
        • DetailView定義をロードします。

          Parameters

          • param: LoadDetailViewDefinitionParameter

            パラメータ

          Returns Promise<ViewInitializationDataResponse<DetailViewDefinition, DetailViewLoadAdditionalResponse>>

          DetailView定義

    • lockEntity: ((param) => Promise<WebApiResponse<LockEntityResponse>>)
        • (param): Promise<WebApiResponse<LockEntityResponse>>
        • Entityデータをロックします。

          Parameters

          • param: LockEntityParameter

            パラメータ

          Returns Promise<WebApiResponse<LockEntityResponse>>

          ロック実行結果

    • saveEntity: ((param) => Promise<WebApiResponse<SaveEntityResponse>>)
        • (param): Promise<WebApiResponse<SaveEntityResponse>>
        • Entityデータを保存します。

          Parameters

          • param: SaveEntityParameter

            パラメータ

          Returns Promise<WebApiResponse<SaveEntityResponse>>

          保存結果

    • startWorkflowProcess: ((param) => Promise<WebApiResponse<StartWorkflowProcessResponse>>)
        • (param): Promise<WebApiResponse<StartWorkflowProcessResponse>>
        • Workflowを起動します。

          Parameters

          • param: StartWorkflowProcessParameter

            パラメータ

          Returns Promise<WebApiResponse<StartWorkflowProcessResponse>>

          Workflow起動結果

    • unlockEntity: ((param) => Promise<WebApiResponse<LockEntityResponse>>)
        • (param): Promise<WebApiResponse<LockEntityResponse>>
        • Entityデータのロックを解除します。

          Parameters

          • param: LockEntityParameter

            パラメータ

          Returns Promise<WebApiResponse<LockEntityResponse>>

          ロック解除結果

    • uploadFile: ((param) => Promise<WebApiResponse<UploadFileResponse>>)
        • (param): Promise<WebApiResponse<UploadFileResponse>>
        • ファイルをアップロードします。

          Parameters

          • param: UploadFileParameter

            パラメータ

          Returns Promise<WebApiResponse<UploadFileResponse>>

          アップロード結果

    Example

    const { deleteEntity } = Mdc.useDetailViewService();
    deleteEntity(
    {
    viewKey: {
    entityName: 'TestEntity',
    viewName: 'DEFAULT'
    },
    entityKey: {
    oid: '1',
    version: 0
    },
    webApi: 'mdc/entityview/detail/delete',
    deleteSpecificVersion: false
    })
    .then(({ isSuccess }) => {
    console.log(isSuccess);
    });

Settings

Member Visibility

Theme

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