PRIMAVERA | Developers

    Show / Hide Table of Contents

    Interface IImoBSApolices

    Classe utilizada para obter serviços e regras de negócio sobre Apólices de Seguros.

    Namespace: IEapBS100
    Assembly: IEapBS100.dll
    Syntax
    [ComVisible(true)]
    [Guid("41788785-4402-43F0-B11F-5982F422DACB")]
    public interface IImoBSApolices

    Methods

    Actualiza(ImoBEApolice, String)

    Actualiza a informação da Apólice.

    Declaration
    void Actualiza(ImoBEApolice BEApolice, string Avisos = "")
    Parameters
    Type Name Description
    ImoBEApolice BEApolice

    Objecto contendo a informação actualizada da Apólice.

    System.String Avisos

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

    ActualizaValorAtributo(String, String, String, String, Object)

    Actualiza o valor de um atributo.

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

    Identificador da Companhia.

    System.String Ramo

    Identificador do Ramo.

    System.String Apolice

    Identificador da Apólice.

    System.String Atributo

    Nome do atributo cujo valor será actualizado.

    System.Object Valor

    Valor do atributo que será actualizado.

    ActualizaValorAtributoID(String, String, Object)

    Actualiza o valor de um atributo.

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

    Identificador (ID) da Apólice.

    System.String Atributo

    Nome do atributo cujo valor será actualizado.

    System.Object Valor

    Valor do atributo que será actualizado.

    ActualizaValorAtributos(String, String, String, StdBECampos)

    Actualiza os valores respectivos de um conjunto de atributos.

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

    Identificador da Companhia.

    System.String Ramo

    Identificador do Ramo.

    System.String Apolice

    Identificador da Apólice.

    StdBECampos Atributos

    Identifica os atributos e os respectivos valores a actualizar.

    ActualizaValorAtributosID(String, StdBECampos)

    Actualiza os valores respectivos de um conjunto de atributos.

    Declaration
    void ActualizaValorAtributosID(string IDApolice, StdBECampos Atributos)
    Parameters
    Type Name Description
    System.String IDApolice

    Identificador (ID) da Apólice.

    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

    DaDescontosHistorico(String, DateTime, ref Double, ref Double, ref Boolean, ref String)

    Devolve os Descontos por referência, de uma Apólice se Seguros, que vigoram numa determinada Data.

    Declaration
    bool DaDescontosHistorico(string IDApolice, DateTime Data, ref double DescontoEmpresa, ref double DescontoEmpregado, ref bool Percentual, ref string Moeda)
    Parameters
    Type Name Description
    System.String IDApolice
    System.DateTime Data

    a procurar o desconto. Pode ser uma data anterior, actual ou superior

    System.Double DescontoEmpresa

    Variável que será preenchida com o valor de desconto da entidade patronal.

    System.Double DescontoEmpregado

    Variável que será preenchida com o valor de desconto do empregado.

    System.Boolean Percentual

    Variável que será preenchida com o valor TRUE se os descontos apresentados estão em percentagem.

    System.String Moeda

    Variável que será preenchida com a moeda do desconto.

    Returns
    Type Description
    System.Boolean

    DaDescontosHistoricoEx(String, DateTime, ref Double, ref Double, ref Boolean, ref String, ref Boolean)

    Devolve os Descontos por referência, de uma Apólice se Seguros, que vigoram numa determinada Data.

    Declaration
    bool DaDescontosHistoricoEx(string IDApolice, DateTime Data, ref double DescontoEmpresa, ref double DescontoEmpregado, ref bool Percentual, ref string Moeda, ref bool DiasTrabalhados)
    Parameters
    Type Name Description
    System.String IDApolice
    System.DateTime Data

    a procurar o desconto. Pode ser uma data anterior, actual ou superior

    System.Double DescontoEmpresa

    Variável que será preenchida com o valor de desconto da entidade patronal.

    System.Double DescontoEmpregado

    Variável que será preenchida com o valor de desconto do empregado.

    System.Boolean Percentual

    Variável que será preenchida com o valor TRUE se os descontos apresentados estão em percentagem.

    System.String Moeda

    Variável que será preenchida com a moeda do desconto.

    System.Boolean DiasTrabalhados

    Variável que será preenchida com o valor TRUE se o valor for proporcional aos dias trabalhados.

    Returns
    Type Description
    System.Boolean

    DaUltimaDataAplicacao(String)

    Devolve a data que vigora (última) os descontos de uma Apólice de Seguros.

    Declaration
    DateTime DaUltimaDataAplicacao(string IDApolice)
    Parameters
    Type Name Description
    System.String IDApolice
    Returns
    Type Description
    System.DateTime

    DaValorAtributo(String, String, String, String)

    Devolve o valor de um atributo.

    Declaration
    dynamic DaValorAtributo(string Companhia, string Ramo, string Apolice, string Atributo)
    Parameters
    Type Name Description
    System.String Companhia

    Identificador da Companhia.

    System.String Ramo

    Identificador do Ramo.

    System.String Apolice

    Identificador da Apólice.

    System.String Atributo

    Nome do atributo cujo valor será devolvido.

    Returns
    Type Description
    System.Object

    DaValorAtributoID(String, String)

    Devolve o valor de um atributo.

    Declaration
    dynamic DaValorAtributoID(string IDApolice, string Atributo)
    Parameters
    Type Name Description
    System.String IDApolice

    Identificador (ID) da Apólice.

    System.String Atributo

    Nome do atributo cujo valor será devolvido.

    Returns
    Type Description
    System.Object

    DaValorAtributos(String, String, String, String[])

    Devolve o valor de um conjunto de atributos.

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

    Identificador da Companhia.

    System.String Ramo

    Identificador do Ramo.

    System.String Apolice

    Identificador da Apólice.

    System.String[] Atributos

    Conjunto de atributos dos quais se pretende obter o valor.

    Returns
    Type Description
    StdBECampos

    DaValorAtributosID(String, String[])

    Devolve o valor de um conjunto de atributos.

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

    Identificador (ID) da Apólice.

    System.String[] Atributos

    Conjunto de atributos dos quais se pretende obter o valor.

    Returns
    Type Description
    StdBECampos

    Edita(String, String, String)

    Edita a informação da Apólice

    Declaration
    ImoBEApolice Edita(string Companhia, string Ramo, string Apolice)
    Parameters
    Type Name Description
    System.String Companhia

    Identificador da Companhia.

    System.String Ramo

    Identificador do Ramo.

    System.String Apolice

    Identificador da Apólice.

    Returns
    Type Description
    ImoBEApolice

    EditaID(String)

    Edita a informação da Apólice.

    Declaration
    ImoBEApolice EditaID(string IDApolice)
    Parameters
    Type Name Description
    System.String IDApolice

    Identificador (ID) da Apólice.

    Returns
    Type Description
    ImoBEApolice

    Existe(String, String, String)

    Verifica se existe a Apólice.

    Declaration
    bool Existe(string Companhia, string Ramo, string Apolice)
    Parameters
    Type Name Description
    System.String Companhia

    Identificador da Companhia.

    System.String Ramo

    Identificador do Ramo.

    System.String Apolice

    Identificador da Apólice.

    Returns
    Type Description
    System.Boolean

    ExisteID(String)

    Verifica se existe a Apólice.

    Declaration
    bool ExisteID(string IDApolice)
    Parameters
    Type Name Description
    System.String IDApolice

    Identificador (ID) da Apólice.

    Returns
    Type Description
    System.Boolean

    Remove(String, String, String)

    Remove a Apólice.

    Declaration
    void Remove(string Companhia, string Ramo, string Apolice)
    Parameters
    Type Name Description
    System.String Companhia

    Identificador da Companhia.

    System.String Ramo

    Identificador do Ramo.

    System.String Apolice

    Identificador da Apólice.

    RemoveID(String, String)

    Remove a Apólice.

    Declaration
    void RemoveID(string IDApolice, string Avisos = "")
    Parameters
    Type Name Description
    System.String IDApolice

    Identificador (ID) da Apólice.

    System.String Avisos

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

    ValidaActualizacao(ImoBEApolice, ref String, String)

    Efectua a validação da informação da Apólice.

    Declaration
    bool ValidaActualizacao(ImoBEApolice BEApolice, ref string ErroValidacao, string AvisoValidacao)
    Parameters
    Type Name Description
    ImoBEApolice BEApolice

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

    System.String ErroValidacao

    Recebe a descrição de eventuais erros detectados.

    System.String AvisoValidacao

    Recebe a descrição de eventuais avisos.

    Returns
    Type Description
    System.Boolean

    ValidaRemocao(String, String, String, String)

    Efectua as validações necessárias à remoção da Apólice.

    Declaration
    bool ValidaRemocao(string Companhia, string Ramo, string Apolice, string ErroValidacao)
    Parameters
    Type Name Description
    System.String Companhia

    Identificador da Companhia.

    System.String Ramo

    Identificador do Ramo.

    System.String Apolice

    Identificador da Apólice.

    System.String ErroValidacao

    Recebe a descrição de eventuais erros detectados.

    Returns
    Type Description
    System.Boolean

    ValidaRemocaoID(String, String)

    Efectua as validações necessárias à remoção da Apólice

    Declaration
    bool ValidaRemocaoID(string IDApolice, string ErroValidacao)
    Parameters
    Type Name Description
    System.String IDApolice

    Identificador (ID) da Apólice.

    System.String ErroValidacao

    Recebe a descrição de eventuais erros detectados.

    Returns
    Type Description
    System.Boolean