PRIMAVERA | Developers

    Show / Hide Table of Contents

    Interface IStpBSDocumentosProcesso

    Classe utilizada para obter serviços e regras de negócio sobre Documentos de Processos.

    Namespace: IStpBS100
    Assembly: IStpBS100.dll
    Syntax
    [ComVisible(true)]
    [Guid("431566EC-95BF-46C6-9C1A-ED73A497E90A")]
    public interface IStpBSDocumentosProcesso

    Methods

    Actualiza(StpBEDocumentoProcesso, String)

    Actualiza a informação do Documento de Processo.

    Declaration
    void Actualiza(StpBEDocumentoProcesso objBE, string Avisos = "")
    Parameters
    Type Name Description
    StpBEDocumentoProcesso objBE

    Objecto contendo a informação actualizada do Documento de Processo.

    System.String Avisos

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

    ActualizaValorAtributo(String, String, Object)

    Actualiza o valor de um atributo.

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

    Identificador do Documento de Processo.

    System.String Atributo

    Nome do atributo cujo valor será actualizado.

    System.Object Valor

    Valor do atributo que será actualizado.

    ActualizaValorAtributos(String, StdBECampos)

    Actualiza os valores respectivos de um conjunto de atributos.

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

    Identificador do Documento de Processo.

    StdBECampos Atributos

    Identifica os atributos e os respectivos valores a actualizar.

    DaDefCamposUtil()

    Devolve as definições dos campos do utilizador.

    Declaration
    StdBEDefCamposUtil DaDefCamposUtil()
    Returns
    Type Description
    StdBEDefCamposUtil

    DaValorAtributo(String, String)

    Devolve o valor de um atributo.

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

    Identificador do Documento de Processo.

    System.String Atributo

    Nome do atributo cujo valor será devolvido.

    Returns
    Type Description
    System.Object

    DaValorAtributos(String, Object[])

    Devolve o valor de um conjunto de atributos.

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

    Identificador do Documento de Processo.

    System.Object[] Atributos

    Conjunto de atributos dos quais se pretende obter o valor.

    Returns
    Type Description
    StdBECampos

    Edita(String)

    Edita a informação do Documento de Processo.

    Declaration
    StpBEDocumentoProcesso Edita(string Documento)
    Parameters
    Type Name Description
    System.String Documento

    Identificador do Documento de Processo.

    Returns
    Type Description
    StpBEDocumentoProcesso

    Existe(String)

    Verifica se existe o Documento de Processo.

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

    Identificador do Documento de Processo.

    Returns
    Type Description
    System.Boolean

    LstDocumentosProcesso()

    Devolve a lista de todos os Documentos de Processos.

    Declaration
    StdBELista LstDocumentosProcesso()
    Returns
    Type Description
    StdBELista

    Remove(String)

    Remove o Documento de Processo.

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

    Identificador do Documento de Processo.

    ValidaActualizacao(StpBEDocumentoProcesso, ref String)

    Efectua a validação da informação do Documento de Processo.

    Declaration
    bool ValidaActualizacao(StpBEDocumentoProcesso objBE, ref string ErroValidacao)
    Parameters
    Type Name Description
    StpBEDocumentoProcesso objBE

    Objecto contendo a informação do Documento de Processo que se pretende validar.

    System.String ErroValidacao

    Recebe a descrição de eventuais erros detectados.

    Returns
    Type Description
    System.Boolean

    ValidaRemocao(String, ref String)

    Efectua as validações necessárias à remoção do Documento de Processo.

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

    Identificador do Documento de Processo.

    System.String ErroValidacao

    Recebe a descrição de eventuais erros detectados.

    Returns
    Type Description
    System.Boolean