@calf/helios/dist/lib/services/execute.service.d.ts

Helios module of Calf framework.

import { IHeliosBuildBrowseResponseFn } from "../interfaces/functions/build-browse-response.interface";
import { IHeliosGetBrowseSpecialParams } from "../interfaces/params/get-browse-special.interface";
import { IHeliosChangeDatabaseParams } from "../interfaces/params/change-database.interface";
import { IHeliosExternalActionParams } from "../interfaces/params/external-action.interface";
import { IHeliosGetBrowseParams } from "../interfaces/params/get-browse.interface";
import { IHeliosBrowseResult } from "../interfaces/results/browse.interface";
import { IHeliosStringResult } from "../interfaces/results/string.interface";
import { IHeliosRequestConfig } from "../interfaces/configs/request.interface";
import { IHeliosLoginParams } from "../interfaces/params/login.interface";
import { IHeliosBooleanResult } from "../interfaces/results/boolean.interface";
import { IHeliosDataSetResult } from "../interfaces/results/data-set.interface";
import { IHeliosDialogResult } from "../interfaces/results/dialog.interface";
import { IHeliosRunParams } from "../interfaces/params/run.interface";
import { IHeliosResultFields } from "../interfaces/fields.interface";
import { IHeliosParams } from "../interfaces/params/params.interface";
import { IHeliosResult } from "../interfaces/results/result.interface";
import { HeliosRuntime } from "../classes/runtime.class";
import { RequestService } from "./request.service";
/**
 * Execute service
 * @description Service for executing methods
 */
export declare class ExecuteService extends RequestService {
    protected readonly ENDPOINT: string[];
    protected readonly isRuntimeDependent: boolean;
    /**
     * Login
     * @description Access or create runtime
     * @param runtime
     * @param params
     * @param config
     */
    login(runtime: HeliosRuntime, params: IHeliosLoginParams, config?: IHeliosRequestConfig): Promise<IHeliosStringResult>;
    /**
     * Logout
     * @description Close given runtime
     * @param runtime
     * @param params
     * @param config
     */
    logout(runtime: HeliosRuntime, params: IHeliosParams, config?: IHeliosRequestConfig): Promise<IHeliosBooleanResult>;
    /**
     * Get version
     * @param runtime
     * @param params
     * @param config
     */
    getVersion(runtime: HeliosRuntime, params: IHeliosParams, config?: IHeliosRequestConfig): Promise<IHeliosStringResult>;
    /**
     * Get main tree
     * @param runtime
     * @param params
     * @param config
     */
    getMainTree(runtime: HeliosRuntime, params: IHeliosParams, config?: IHeliosRequestConfig): Promise<IHeliosDataSetResult>;
    /**
     * Get navigation tree
     * @param runtime
     * @param params
     * @param config
     */
    getNavigationTree(runtime: HeliosRuntime, params: IHeliosParams, config?: IHeliosRequestConfig): Promise<IHeliosDataSetResult>;
    /**
     * Get databases
     * @param runtime
     * @param params
     * @param config
     */
    getDatabases(runtime: HeliosRuntime, params: IHeliosParams, config?: IHeliosRequestConfig): Promise<IHeliosDataSetResult>;
    /**
     * Get browse
     * @param runtime
     * @param params
     * @param buildBrowseResponseFn
     * @param config
     */
    getBrowse(runtime: HeliosRuntime, params: IHeliosGetBrowseParams, buildBrowseResponseFn?: IHeliosBuildBrowseResponseFn<any>, config?: IHeliosRequestConfig): Promise<IHeliosBrowseResult>;
    /**
     * Get browse
     * @param runtime
     * @param params
     * @param buildBrowseResponseFn
     * @param config
     */
    getBrowseSpecial(runtime: HeliosRuntime, params: IHeliosGetBrowseSpecialParams, buildBrowseResponseFn?: IHeliosBuildBrowseResponseFn<any>, config?: IHeliosRequestConfig): Promise<IHeliosBrowseResult>;
    /**
     * Change database
     * @param runtime
     * @param params
     * @param config
     */
    changeDatabase(runtime: HeliosRuntime, params: IHeliosChangeDatabaseParams, config?: IHeliosRequestConfig): Promise<IHeliosDialogResult>;
    /**
     * Run procedure
     * @param runtime
     * @param params
     * @param config
     */
    runProcedure<TResult>(runtime: HeliosRuntime, params: IHeliosRunParams, config?: IHeliosRequestConfig): Promise<IHeliosResult<IHeliosResultFields<TResult>>>;
    /**
     * Run view
     * @param runtime
     * @param params
     * @param config
     */
    runView(runtime: HeliosRuntime, params: IHeliosRunParams, config?: IHeliosRequestConfig): Promise<IHeliosDataSetResult>;
    /**
     * Run function
     * @param runtime
     * @param params
     * @param config
     */
    runFunction<TResult>(runtime: HeliosRuntime, params: IHeliosRunParams, config?: IHeliosRequestConfig): Promise<IHeliosResult<IHeliosResultFields<TResult>>>;
    /**
     * Run external action
     * @param runtime
     * @param params
     * @param buildBrowseResponseFn
     * @param config
     * @returns
     */
    runExternalAction<TResult>(runtime: HeliosRuntime, params: IHeliosExternalActionParams, buildBrowseResponseFn?: IHeliosBuildBrowseResponseFn<any>, config?: IHeliosRequestConfig): Promise<IHeliosResult<IHeliosResultFields<TResult>>>;
    /**
     * Parse request params
     * @description Parse request params, ensuring
     * it contains needed values and assigning default
     * ones if those values are absent.
     * @param params
     */
    protected parseRequestParams<TParams extends IHeliosParams>(params: TParams): Promise<TParams>;
}