fluig-types/src/types/backend/datasets/dataset.d.ts

Totvs Fluig Types for Typescript

/** @format */

declare class Constraint {
    fieldName: string;
    initialValue: string;
    finalValue: string;
    constraintType: ConstraintType;

    /**
     * Indica que a constraint fará uma busca usando LIKE ao invés de =
     */
    setLikeSearch(likeSearch: boolean): void;

    getFieldName(): string;
    getInitialValue(): string;
    getFinalValue(): string;
}

/**
 * Tipos de campo de um Dataset
 *
 * Usado na criação do Dataset, na função defineStructure.
 */
declare enum DatasetFieldType {
    NUMBER,
    STRING,
    TEXT,
    DATE,
    BOOLEAN,
}

/**
 * Cria uma coluna no dataset sincronizado
 */
declare function addColumn(coluna: string, tipo?: DatasetFieldType);

/**
 * Cria a chave principal do dataset sincronizado
 *
 * Para uso dos métodos updateRecord, deleteRecord e addOrUpdate do dataset sincronizado.
 */
declare function setKey(chaves: string[]): void;

/**
 * Cria um ou mais índices para maior performance na consulta do dataset sincronizado
 */
declare function addIndex(indices: string[]): void;

/**
 * Indicativo das restrições ao sincronizar dados em Mobile
 */
interface DatasetMobileSync {
    /**
     * As colunas (em letras maiúsculas) a serem salvas no Mobile
     */
    fields: string[];

    /**
     * Os filtros adicionais
     */
    constraints: Constraint[];

    /**
     * Campos da ordenação
     */
    sortFields: string[];
}