PRIMAVERA | Developers

    Show / Hide Table of Contents

    Interface ICblBSSVATDiagnosticTask

    This holds the lifecycle of a SVAT diagnostic task

    Inherited Members
    System.IDisposable.Dispose()
    Namespace: ICblBS100
    Assembly: ICblBS100.dll
    Syntax
    [ComVisible(true)]
    [Guid("D9ABACC0-A970-4E68-A7A8-46177A45C082")]
    public interface ICblBSSVATDiagnosticTask : IDisposable

    Properties

    Count

    Number of rows in the datatable

    Declaration
    int Count { get; }
    Property Value
    Type Description
    System.Int32

    DataTable

    Result from the execution

    Declaration
    DataTable DataTable { get; }
    Property Value
    Type Description
    System.Data.DataTable

    Definition

    Definition of the diagnostic

    Declaration
    CblBESVATDiagnostic Definition { get; }
    Property Value
    Type Description
    CblBESVATDiagnostic

    Exception

    Exception caught in the execution

    Declaration
    Exception Exception { get; }
    Property Value
    Type Description
    System.Exception

    FullDiagnosticCompleted

    Indicates whether or not the full query completed execution

    Declaration
    bool FullDiagnosticCompleted { get; }
    Property Value
    Type Description
    System.Boolean

    MinimalDiagnosticCompleted

    Indicates whether or not the minimal query completed execution

    Declaration
    bool MinimalDiagnosticCompleted { get; }
    Property Value
    Type Description
    System.Boolean

    Running

    Indicates whether or not it's running any query

    Declaration
    bool Running { get; }
    Property Value
    Type Description
    System.Boolean

    RunningFull

    Indicates whether or not it's running the full query

    Declaration
    bool RunningFull { get; }
    Property Value
    Type Description
    System.Boolean

    RunningMinimal

    Indicates whether or not it's running the minimal query

    Declaration
    bool RunningMinimal { get; }
    Property Value
    Type Description
    System.Boolean

    Methods

    CreateParameters(String, String, Int32, String, BasBETipos.EnumTipoExercicioContabilidade, DateTime, DateTime)

    Cria a lista de parametros para a execução da tarefas.

    Declaration
    StdBECampos CreateParameters(string tipoLancamento, string enterprise, int ano, string moeda, BasBETipos.EnumTipoExercicioContabilidade tipoExercicioCBL, DateTime dataInicial, DateTime dataFinal)
    Parameters
    Type Name Description
    System.String tipoLancamento
    System.String enterprise
    System.Int32 ano
    System.String moeda
    BasBETipos.EnumTipoExercicioContabilidade tipoExercicioCBL
    System.DateTime dataInicial
    System.DateTime dataFinal
    Returns
    Type Description
    StdBECampos

    GetExecutionParameter(StdBECampos, String)

    Devolve o valor do parametro.

    Declaration
    StdBECampo GetExecutionParameter(StdBECampos objParameters, string parameterName)
    Parameters
    Type Name Description
    StdBECampos objParameters
    System.String parameterName
    Returns
    Type Description
    StdBECampo

    Reset()

    Declaration
    void Reset()

    Run(StdBECampos)

    Run the minimal query task

    Declaration
    void Run(StdBECampos objParameters)
    Parameters
    Type Name Description
    StdBECampos objParameters

    RunAsync(StdBECampos, Boolean)

    Run the minimal query task async

    Declaration
    Task RunAsync(StdBECampos objParameters, bool ignorePreviousResults)
    Parameters
    Type Name Description
    StdBECampos objParameters
    System.Boolean ignorePreviousResults
    Returns
    Type Description
    System.Threading.Tasks.Task

    RunDetailed(StdBECampos)

    Run the full query task

    Declaration
    void RunDetailed(StdBECampos objParameters)
    Parameters
    Type Name Description
    StdBECampos objParameters

    RunDetailedAsync(StdBECampos, Boolean)

    Run the full query task async

    Declaration
    Task RunDetailedAsync(StdBECampos objParameters, bool ignorePreviousResults)
    Parameters
    Type Name Description
    StdBECampos objParameters
    System.Boolean ignorePreviousResults
    Returns
    Type Description
    System.Threading.Tasks.Task

    RunDetailedDiagnostics(StdBECampos, Boolean)

    Runs at detailed level the available diagnostics for a given company

    Declaration
    void RunDetailedDiagnostics(StdBECampos objParameters, bool ignorePreviousResults)
    Parameters
    Type Name Description
    StdBECampos objParameters
    System.Boolean ignorePreviousResults

    RunDiagnostics(StdBECampos, Boolean)

    Runs minimaly all the available diagnostics for a given company

    Declaration
    void RunDiagnostics(StdBECampos objParameters, bool ignorePreviousResults)
    Parameters
    Type Name Description
    StdBECampos objParameters
    System.Boolean ignorePreviousResults

    RunDiagnosticsAsync(StdBECampos, Boolean, Int32)

    Runs minimaly all the available diagnostics for a given company async

    Declaration
    Task<bool> RunDiagnosticsAsync(StdBECampos objParameters, bool ignorePreviousResults, int timeOut = -1)
    Parameters
    Type Name Description
    StdBECampos objParameters
    System.Boolean ignorePreviousResults
    System.Int32 timeOut

    Specify in seconds the time before time out

    Returns
    Type Description
    System.Threading.Tasks.Task<System.Boolean>

    Events

    Completed

    Completed Event

    Declaration
    event CompletedHandler Completed
    Event Type
    Type Description
    CompletedHandler