PRIMAVERA | Developers

    Show / Hide Table of Contents

    Interface IRhpBSEstadosPlanos

    Classe utilizada para obter as regras de negócio dos Estados dos Planos.

    Namespace: IRhpBS100
    Assembly: IRhpBS100.dll
    Syntax
    [ComVisible(true)]
    [Guid("393EDB13-69FC-4E40-B5A8-CD9DB57ADFA9")]
    public interface IRhpBSEstadosPlanos

    Methods

    Actualiza(RhpBEEstadoPlano, String)

    Actualiza a informação de um Estado do Plano.

    Declaration
    void Actualiza(RhpBEEstadoPlano objBEEstado, string Avisos = "")
    Parameters
    Type Name Description
    RhpBEEstadoPlano objBEEstado

    Objecto que encapsula toda a informação acerca de um estado de plano.

    System.String Avisos

    Parâmetro não utilizado.

    ActualizaValorAtributo(String, String, Object)

    Actualiza o valor de um atributo.

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

    Identificador do estado do plano.

    System.String Atributo

    Identificador do atributo que se pretende alterar.

    System.Object Valor

    Valor do atributo especificado em "Atributo".

    ActualizaValorAtributos(String, StdBECampos)

    Actualiza os valores respectivos de um conjunto de atributos.

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

    Identificador do estado do plano.

    StdBECampos Atributos

    Objecto composto pelos atributo a alterar e os seus novos valores.

    DaDefCamposUtil()

    Devolve as definições dos campos do utilizador.

    Declaration
    StdBEDefCamposUtil DaDefCamposUtil()
    Returns
    Type Description
    StdBEDefCamposUtil

    DaEstadoNoMomento(Byte)

    Devolve o Estado do Plano no momento.

    Declaration
    string DaEstadoNoMomento(byte Momento)
    Parameters
    Type Name Description
    System.Byte Momento

    Identificador do momento que identifica o estado.

    Returns
    Type Description
    System.String

    DaValorAtributo(String, String)

    Devolve o valor de um atributo.

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

    Identificador do estado do plano.

    System.String Atributo

    Identificador do atributo que se pretende obter.

    Returns
    Type Description
    System.Object

    DaValorAtributos(String, String[])

    Devolve o valor de um conjunto de atributos.

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

    Identificador do estado do plano.

    System.String[] Atributos

    Identificadores dos atributos que se pretende obter.

    Returns
    Type Description
    StdBECampos

    Edita(String)

    Edita a informação de um Estado do Plano.

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

    Identificador do estado do plano.

    Returns
    Type Description
    RhpBEEstadoPlano

    Existe(String)

    Verifica se existe o registo referente à informação passada nos parâmetros.

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

    identificador do estado do plano.

    Returns
    Type Description
    System.Boolean

    Remove(String)

    Remove a informação de um Estado do Plano.

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

    Identificador do estado do plano.

    ValidaActualizacao(RhpBEEstadoPlano, ref String)

    Efectua as validações necessárias à actualização de um Estado do Plano.

    Declaration
    bool ValidaActualizacao(RhpBEEstadoPlano ObjEstado, ref string ErroValidacao)
    Parameters
    Type Name Description
    RhpBEEstadoPlano ObjEstado
    System.String ErroValidacao

    variável que retorna as descrições dos erros de validação, caso existam.

    Returns
    Type Description
    System.Boolean

    ValidaRemocao(String, ref String)

    Efectua a validação de um registo antes de ser efectuada a sua remoção.

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

    Identificador do estado do plano.

    System.String ErroValidacao

    variável que retorna as descrições dos erros de validação, caso existam.

    Returns
    Type Description
    System.Boolean

    ValidaSequenciaDeEstados(String, out String)

    Valida a sequência de estados.

    Declaration
    bool ValidaSequenciaDeEstados(string Estado, out string strErros)
    Parameters
    Type Name Description
    System.String Estado

    Identificador do estado do plano.

    System.String strErros

    Variável que retorna os erros de validação, caso existam.

    Returns
    Type Description
    System.Boolean