PRIMAVERA | Developers

    Show / Hide Table of Contents

    Interface IOrcBSEstadosProcExecucao

    Motor dos estados dos processos de execução

    Namespace: IOrcBS100
    Assembly: IOrcBS100.dll
    Syntax
    [ComVisible(true)]
    [Guid("A4A3E6C4-D25A-4FA1-B0DA-694CE59A24A8")]
    public interface IOrcBSEstadosProcExecucao

    Methods

    Actualiza(OrcBEEstadoProcExecucao, String)

    Procedimento para actualização de um estado de processo de execução.

    Declaration
    void Actualiza(OrcBEEstadoProcExecucao BEEstadoProcExecucao, string Avisos = "")
    Parameters
    Type Name Description
    OrcBEEstadoProcExecucao BEEstadoProcExecucao

    Objecto contendo a informação actualizada do um estado de processo de execução.

    System.String Avisos

    Notificação devolvida pelo processo de actualização.

    ActualizaNumerador(Int32, String, Int32)

    Atualiza o numerador de determinado estado

    Declaration
    void ActualizaNumerador(int Ano, string Chave, int Numerador)
    Parameters
    Type Name Description
    System.Int32 Ano

    Ano do exercício.

    System.String Chave

    Chave do estado

    System.Int32 Numerador

    Numerador a atualizar

    ActualizaValorAtributo(String, String, Object)

    Actualiza o valor de um atributo.

    Declaration
    void ActualizaValorAtributo(string Estado, string Atributo, dynamic Valor)
    Parameters
    Type Name Description
    System.String Estado

    Identificador de um estado orçamental.

    System.String Atributo

    Nome do atributo cujo valor será actualizado.

    System.Object Valor

    Valor do atributo que será actualizado.

    ActualizaValorAtributoNumerador(Int32, String, String, Object)

    Actualiza o valor de um atributo na tablea do numerador do estado do processo de execução.

    Declaration
    void ActualizaValorAtributoNumerador(int Ano, string Estado, string Atributo, dynamic Valor)
    Parameters
    Type Name Description
    System.Int32 Ano

    Ano do exercício.

    System.String Estado

    Estado orçamental a validar

    System.String Atributo

    Atributo a atualizar

    System.Object Valor

    Valor a atualizar

    ActualizaValorAtributos(String, StdBECampos)

    Actualiza os valores respectivos de um conjunto de atributos.

    Declaration
    void ActualizaValorAtributos(string StrChave, StdBECampos Atributos)
    Parameters
    Type Name Description
    System.String StrChave

    Identificador de um estado de processo de execução.

    StdBECampos Atributos

    Identifica os atributos e os respectivos valores a actualizar.

    DaContrato_NumeradorEstadoNoutroContrato(String, Int32, String, Int32, String, String, Int32)

    Devolve o contrato onde o numerador do estado existe em determinado processo, que não o passado por parâmetro

    Declaration
    string DaContrato_NumeradorEstadoNoutroContrato(string Estado, int NumEstado, string Processo, int Ano, string contratoID, string diario = "", int numdiario = 0)
    Parameters
    Type Name Description
    System.String Estado

    Estado orçamental a validar

    System.Int32 NumEstado

    Númerador do estado a validar

    System.String Processo

    Processo de execução

    System.Int32 Ano

    Ano do exercício.

    System.String contratoID

    ID do contrato

    System.String diario

    diario, quando o documento está em modo de edição

    System.Int32 numdiario

    numerador do diário, quando o documento está em modo de edição

    Returns
    Type Description
    System.String

    Contrato onde o numerador do estado existe em determinado processo, que não o passado por parâmetro

    DaDefCamposUtil()

    Devolve as definições dos campos do utilizador.

    Declaration
    StdBEDefCamposUtil DaDefCamposUtil()
    Returns
    Type Description
    StdBEDefCamposUtil

    Definições dos campos do utilizador.

    DaDescricao(String)

    Devolve a descrição associada ao estado de processo de execução.

    Declaration
    string DaDescricao(string Estado)
    Parameters
    Type Name Description
    System.String Estado

    Identificador de um estado orçamental.

    Returns
    Type Description
    System.String

    Descrição associada ao estado de processo de execução.

    DaEstadosComNumerador(Int32)

    Devolve a lista de estados com numerador para o ano passado por parâmetro

    Declaration
    PrimaveraOrderedDictionary DaEstadosComNumerador(int Ano)
    Parameters
    Type Name Description
    System.Int32 Ano

    Ano do exercício.

    Returns
    Type Description
    Primavera.Platform.Collections.PrimaveraOrderedDictionary

    Lista de estados com numerador

    DaNumeradoresEstadoContinuo_NosMovimentos(String, String, String)

    Devolve lista de numeradores usados em MovsProcExecucao

    Declaration
    int[] DaNumeradoresEstadoContinuo_NosMovimentos(string Estado, string Processo, string contratroID)
    Parameters
    Type Name Description
    System.String Estado

    Estado orçamental.

    System.String Processo

    Processo de execução.

    System.String contratroID

    ID do contrato.

    Returns
    Type Description
    System.Int32[]

    Lista de numeradores usados em MovsProcExecucao

    DaNumeradorEstadoNosMovimentos(String, Int32, Int32, String, String, String, String, String, String, String, String, String, String, String)

    Devolve o numEstado lançado por um documento contabilístico, nos movimentos orçamentais (ou rascunho), em função do processo, ano, estado, entidade e classificações

    Declaration
    int DaNumeradorEstadoNosMovimentos(string Diario, int NumDiario, int Ano, string Processo, string Estado, string Entidade, string ClassEcon, string ClassOrgan, string FonteFinanc, string Actividade, string ProgMedida, string IdProjecto, string WBSItem, string ContratoID)
    Parameters
    Type Name Description
    System.String Diario

    Diário contabilístico

    System.Int32 NumDiario

    Numerador do diário contabilístico

    System.Int32 Ano

    Ano do exercício.

    System.String Processo

    Processo de execução

    System.String Estado

    Estado orçamental a validar

    System.String Entidade

    Entidade

    System.String ClassEcon

    Classificação económica.

    System.String ClassOrgan

    Classificação orgânica.

    System.String FonteFinanc

    Fonte de financiamento.

    System.String Actividade

    Atividade

    System.String ProgMedida

    Programa/Medida

    System.String IdProjecto

    Id do Projecto / GOP

    System.String WBSItem

    WBSItem (elem. do plano de execução do projeto)

    System.String ContratoID

    ID do contrato"

    Returns
    Type Description
    System.Int32

    Numerador do estado lançado por um documento contabilístico

    DaProcesso_NumeradorEstadoNoutroProcesso(String, Int32, Int32, String)

    Devolve o processo de execução onde o numerador do estado existe, que não o passado por parâmetro

    Declaration
    string DaProcesso_NumeradorEstadoNoutroProcesso(string Estado, int NumEstado, int Ano, string Processo)
    Parameters
    Type Name Description
    System.String Estado

    Estado orçamental a validar

    System.Int32 NumEstado

    Númerador do estado a validar

    System.Int32 Ano

    Ano do exercício.

    System.String Processo

    Processo de execução

    Returns
    Type Description
    System.String

    Processo de execução onde o numerador do estado existe, que não o passado por parâmetro

    DaValorAtributo(String, String)

    Devolve o valor de um atributo.

    Declaration
    dynamic DaValorAtributo(string Estado, string Atributo)
    Parameters
    Type Name Description
    System.String Estado

    Identificador de um estado orçamental.

    System.String Atributo

    Nome do atributo cujo valor será devolvido.

    Returns
    Type Description
    System.Object

    Valor do atributo passado por parâmetro

    DaValorAtributos(String, Object[])

    Devolve o valor de um conjunto de atributos.

    Declaration
    StdBECampos DaValorAtributos(string Estado, params dynamic[] Atributos)
    Parameters
    Type Name Description
    System.String Estado

    Identificador de um estado orçamental.

    System.Object[] Atributos

    Conjunto de atributos dos quais se pretende devolver o valor.

    Returns
    Type Description
    StdBECampos

    Lista de atributos mapeados em objetos do tipo StdBECampo

    Edita(Int32, String)

    Procedimento para edição de um estado de processo de execução.

    Declaration
    OrcBEEstadoProcExecucao Edita(int Ano, string Estado)
    Parameters
    Type Name Description
    System.Int32 Ano

    Ano do exercício.

    System.String Estado

    Estado de processo de execução.

    Returns
    Type Description
    OrcBEEstadoProcExecucao

    Objecto com ainformação atualizada do estado

    Existe(String)

    Verifica se já existe o estado de processo de execução.

    Declaration
    bool Existe(string Estado)
    Parameters
    Type Name Description
    System.String Estado

    Identificador de um estado orçamental.

    Returns
    Type Description
    System.Boolean

    true se existe, false caso contrário

    ExisteNumeradorEstadoNosMovimentos(String, Int32, String, Int32, String, String, String, String, String, String, String, String, String)

    Valida se o Numerador do Estado existe nos Movimentos

    Declaration
    bool ExisteNumeradorEstadoNosMovimentos(string Estado, int NumEstado, string entidade, int Ano, string IdProjecto, string WBSItem, string ClassOrgan, string FonteFinanc, string Actividade, string ProgMedida, string ClassEcon, string Processo, string ContratoID)
    Parameters
    Type Name Description
    System.String Estado

    Estado orçamental a validar

    System.Int32 NumEstado

    Númerador do estado a validar

    System.String entidade

    Entidade

    System.Int32 Ano

    Ano do exercício.

    System.String IdProjecto

    Id do Projecto / GOP

    System.String WBSItem

    WBSItem (elem. do plano de execução do projeto)

    System.String ClassOrgan

    Classificação orgânica.

    System.String FonteFinanc

    Fonte de financiamento.

    System.String Actividade

    Atividade

    System.String ProgMedida

    Programa/Medida

    System.String ClassEcon

    Classificação económica.

    System.String Processo

    Processo de execução

    System.String ContratoID

    ID do contrato"

    Returns
    Type Description
    System.Boolean

    true se existe, false caso contrário

    ExisteNumeradorEstadoNosMovimentos(String, Int32, String, Int32, String, String, String, String, String, String, String, String, String, String, Int32)

    Valida se o Numerador do Estado existe nos Movimentos

    Declaration
    bool ExisteNumeradorEstadoNosMovimentos(string Estado, int NumEstado, string Entidade, int Ano, string IdProjecto, string WBSItem, string ClassOrgan, string FonteFinanc, string Actividade, string ProgMedida, string ClassEcon, string Processo, string ContratoID, string Diario, int NumDiario)
    Parameters
    Type Name Description
    System.String Estado

    Estado orçamental.

    System.Int32 NumEstado

    Númerador do estado.

    System.String Entidade

    Entidade

    System.Int32 Ano

    Ano do exercício.

    System.String IdProjecto

    Id do Projecto / GOP

    System.String WBSItem

    WBSItem (elem. do plano de execução do projeto)

    System.String ClassOrgan

    Classificação orgânica.

    System.String FonteFinanc

    Fonte de financiamento

    System.String Actividade

    Atividade.

    System.String ProgMedida

    Programa/Medida.

    System.String ClassEcon

    Classificação económica.

    System.String Processo

    Processo de execução.

    System.String ContratoID

    ID do contrato"

    System.String Diario

    Diário contabilístico.

    System.Int32 NumDiario

    Numerador do diário contabilístico.

    Returns
    Type Description
    System.Boolean

    true se existe, false caso contrário

    ExisteNumeradorEstadoNosMovimentosRascunho(String, Int32, String, Int32, String, String, String, String, String, String, String, String, String)

    Valida se o Numerador do Estado existe nos Movimentos em Rascunho

    Declaration
    bool ExisteNumeradorEstadoNosMovimentosRascunho(string Estado, int NumEstado, string Entidade, int Ano, string IdProjecto, string WBSItem, string ClassOrgan, string FonteFinanc, string Actividade, string ProgMedida, string ClassEcon, string Processo, string ContratoID)
    Parameters
    Type Name Description
    System.String Estado

    Estado orçamental a validar

    System.Int32 NumEstado

    Númerador do estado a validar

    System.String Entidade

    Entidade

    System.Int32 Ano

    Ano do exercício.

    System.String IdProjecto

    Id do Projecto / GOP

    System.String WBSItem

    WBSItem (elem. do plano de execução do projeto)

    System.String ClassOrgan

    Classificação orgânica.

    System.String FonteFinanc

    Fonte de financiamento.

    System.String Actividade

    Atividade

    System.String ProgMedida

    Programa/Medida

    System.String ClassEcon

    Classificação económica.

    System.String Processo

    Processo de execução

    System.String ContratoID

    ID do contrato"

    Returns
    Type Description
    System.Boolean

    true se existe, false caso contrário

    ExisteNumeradorEstadoNosMovimentosRascunho(String, Int32, String, Int32, String, String, String, String, String, String, String, String, String, String, Int32)

    Valida se o Numerador do Estado existe nos Movimentos em Rascunho

    Declaration
    bool ExisteNumeradorEstadoNosMovimentosRascunho(string Estado, int NumEstado, string Entidade, int Ano, string IdProjecto, string WBSItem, string ClassOrgan, string FonteFinanc, string Actividade, string ProgMedida, string ClassEcon, string Processo, string ContratoID, string Diario, int NumDiario)
    Parameters
    Type Name Description
    System.String Estado

    Estado orçamental a validar

    System.Int32 NumEstado

    Númerador do estado a validar

    System.String Entidade

    Entidade

    System.Int32 Ano

    Ano do exercício.

    System.String IdProjecto

    Id do Projecto / GOP

    System.String WBSItem

    WBSItem (elem. do plano de execução do projeto)

    System.String ClassOrgan

    Classificação orgânica.

    System.String FonteFinanc

    Fonte de financiamento.

    System.String Actividade

    Atividade

    System.String ProgMedida

    Programa/Medida

    System.String ClassEcon

    Classificação económica.

    System.String Processo

    Processo de execução

    System.String ContratoID

    ID do contrato"

    System.String Diario

    Diário contabilístico.

    System.Int32 NumDiario

    Numerador do diário contabilístico.

    Returns
    Type Description
    System.Boolean

    true se existe, false caso contrário

    ExisteNumeradorEstadoNoutroContrato(String, Int32, String, Int32, String, String, Int32)

    Valida se existe algum contrato (mesmo que vazio) onde o numerador do estado existe em determinado processo, que não o passado por parâmetro

    Declaration
    bool ExisteNumeradorEstadoNoutroContrato(string Estado, int NumEstado, string Processo, int Ano, string contratoID, string diario = "", int numdiario = 0)
    Parameters
    Type Name Description
    System.String Estado

    Estado orçamental a validar

    System.Int32 NumEstado

    Númerador do estado a validar

    System.String Processo

    Processo de execução

    System.Int32 Ano

    Ano do exercício.

    System.String contratoID

    ID do contrato

    System.String diario

    diario, quando o documento está em modo de edição

    System.Int32 numdiario

    numerador do diário, quando o documento está em modo de edição

    Returns
    Type Description
    System.Boolean

    true se existe, false caso contrário

    ExisteNumeradorEstadoNoutroProcesso(String, Int32, Int32, String)

    Valida se o Numerador do Estado existe noutro processo que não o passado por parâmetro

    Declaration
    bool ExisteNumeradorEstadoNoutroProcesso(string Estado, int NumEstado, int Ano, string Processo)
    Parameters
    Type Name Description
    System.String Estado

    Estado orçamental a validar.

    System.Int32 NumEstado

    Númerador do estado a validar.

    System.Int32 Ano

    Ano do exercício.

    System.String Processo

    Processo de execução

    Returns
    Type Description
    System.Boolean

    true se existe, false caso contrário

    lstEstadosProcExecucao()

    Listagem de estados de processo de execução.

    Declaration
    StdBELista lstEstadosProcExecucao()
    Returns
    Type Description
    StdBELista

    Lista de estados dos processos de execução

    NumeroActual(Int32, String)

    Devolve o númerador atual de um estado orçamental

    Declaration
    int NumeroActual(int Ano, string Estado)
    Parameters
    Type Name Description
    System.Int32 Ano

    Ano do exercício.

    System.String Estado

    Estado orçamental a validar

    Returns
    Type Description
    System.Int32

    Númerador atual de um estado orçamental

    Remove(String)

    Procedimento para remoção de estados de processo de execução. Parte do príncipio que as validações já foram efectuadas através do método ValidaRemocao(String, ref String)

    Declaration
    void Remove(string Estado)
    Parameters
    Type Name Description
    System.String Estado

    Identificador de um estado orçamental.

    ValidaActualizacao(OrcBEEstadoProcExecucao, ref String)

    Efectua a validação da informação de um estado de processo de execução.

    Declaration
    bool ValidaActualizacao(OrcBEEstadoProcExecucao EstadoProcExecucao, ref string ErroValidacao)
    Parameters
    Type Name Description
    OrcBEEstadoProcExecucao EstadoProcExecucao

    Objecto contendo a informação que se pretende validar.

    System.String ErroValidacao

    Recebe a descrição de eventuais erros detetados.

    Returns
    Type Description
    System.Boolean

    true caso a validação tenha sucedido, false caso contrário

    ValidaRemocao(String, ref String)

    Efectua as validações necessárias à remoção do um estado de processo de execução.

    Declaration
    bool ValidaRemocao(string Estado, ref string ErroValidacao)
    Parameters
    Type Name Description
    System.String Estado

    Identificador de um estado orçamental.

    System.String ErroValidacao

    Recebe a descrição de eventuais erros detetados.

    Returns
    Type Description
    System.Boolean

    true caso a validação tenha sucedido, false caso contrário