PRIMAVERA | Developers

    Show / Hide Table of Contents

    Interface IBasBSPeriodoExcecoes

    Namespace: IBasBS100
    Assembly: IBasBS100.dll
    Syntax
    [ComVisible(true)]
    [Guid("0D1CA21E-9DA4-400A-863E-A01056235671")]
    public interface IBasBSPeriodoExcecoes

    Methods

    Actualiza(BasBEPeriodoExcecao, String)

    Actualiza a Exceção ao Período

    Declaration
    void Actualiza(BasBEPeriodoExcecao PeriodoExcecao, string Avisos)
    Parameters
    Type Name Description
    BasBEPeriodoExcecao PeriodoExcecao

    Entidade Exceção ao Período

    System.String Avisos

    Retorna avisos na actualização

    ActualizaColecao(BasBEPeriodoExcecoes, ref String)

    Actualiza a coleção de Exceções ao Período

    Declaration
    void ActualizaColecao(BasBEPeriodoExcecoes Colecao, ref string Avisos)
    Parameters
    Type Name Description
    BasBEPeriodoExcecoes Colecao

    Coleção de Exceções ao Período

    System.String Avisos

    Retorna avisos na actualização

    ActualizaValorAtributoId(String, String, Object)

    Actualizar o valor do atributo especificado da exceção ao período

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

    Identificador do registo

    System.String Atributo

    Atributo a actualizar

    System.Object Valor

    Valor do atributo a actualizar

    ActualizaValorAtributosId(String, StdBECampos)

    Actualiza os atributos da Exceção ao Período

    Declaration
    void ActualizaValorAtributosId(string Id, StdBECampos Atributos)
    Parameters
    Type Name Description
    System.String Id

    Identificador do registo

    StdBECampos Atributos

    Array com os atributos a actualizar

    CalculaRecorrencias(BasBEPeriodoExcecao, Int32)

    Calcula as ocorrências da Exceção ao Período e devolve o número de ocorrências

    Declaration
    int CalculaRecorrencias(BasBEPeriodoExcecao PeriodoExcecao, int NumMaxOcorrencias)
    Parameters
    Type Name Description
    BasBEPeriodoExcecao PeriodoExcecao

    Exceção ao Período

    System.Int32 NumMaxOcorrencias

    Número máximo de ocorrências

    Returns
    Type Description
    System.Int32

    CopiaEntreAnos(Int32, Int32, String, String, Int32, String)

    Copia Exceções de um tipo entre dois anos

    Declaration
    int CopiaEntreAnos(int AnoOrigem, int AnoDestino, string Modulo, string SubModulo, int TipoExcecao, string Avisos)
    Parameters
    Type Name Description
    System.Int32 AnoOrigem

    Ano (Exercicio) de origem

    System.Int32 AnoDestino

    Ano (Exercicio) de destino

    System.String Modulo

    Módulo do tipo de exceção

    System.String SubModulo

    Sub Módulo do tipo de exceção

    System.Int32 TipoExcecao

    Tipo de exceção

    System.String Avisos

    Devolve eventuais avisos

    Returns
    Type Description
    System.Int32

    DaValorAtributoID(String, String)

    Devolve o valor do atributo especificado da Exceção ao Período

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

    Identificador da Exceção ao Período

    System.String Atributo

    Atributo a obter o valor

    Returns
    Type Description
    System.Object

    DaValorAtributosID(String, String[])

    Devolve um array com os atributos espeficidados

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

    Identificador da Exceção ao Período

    System.String[] Atributos
    Returns
    Type Description
    StdBECampos

    EditaId(String)

    Edita a Exceção ao Período

    Declaration
    BasBEPeriodoExcecao EditaId(string Id)
    Parameters
    Type Name Description
    System.String Id

    Identificador da Exceção ao Período

    Returns
    Type Description
    BasBEPeriodoExcecao

    EditaListaEntidade(String, String, String, DateTime, DateTime)

    Devolve uma coleção de Exceções ao Período para o conjunto Modulo, SubModulo e Entidade existentes no período especificado

    Declaration
    BasBEPeriodoExcecoes EditaListaEntidade(string Modulo, string SubModulo, string Entidade, DateTime PeriodoInicial, DateTime PeriodoFinal)
    Parameters
    Type Name Description
    System.String Modulo

    Módulo Conjunto de 3 caracteres identificativos do módulo

    System.String SubModulo

    Sub-Módulo Conjunto de 3 caracteres identificativo do sub-módulo

    System.String Entidade

    Código da Entidade a que está associada

    System.DateTime PeriodoInicial

    Limite inferior do perído (pode ser passado CDate(0) para não limitar)

    System.DateTime PeriodoFinal

    Limite superior do perído (pode ser passado CDate(0) para não limitar)

    Returns
    Type Description
    BasBEPeriodoExcecoes

    EditaListaModulo(String, DateTime, DateTime)

    Devolve uma coleção de Exceções ao Período para o Modulo existentes no período especificado

    Declaration
    BasBEPeriodoExcecoes EditaListaModulo(string Modulo, DateTime PeriodoInicial, DateTime PeriodoFinal)
    Parameters
    Type Name Description
    System.String Modulo

    Módulo Conjunto de 3 caracteres identificativos do módulo

    System.DateTime PeriodoInicial

    Limite inferior do perído (pode ser passado CDate(0) para não limitar)

    System.DateTime PeriodoFinal

    Limite superior do perído (pode ser passado CDate(0) para não limitar)

    Returns
    Type Description
    BasBEPeriodoExcecoes

    EditaListaSubModulo(String, String, DateTime, DateTime)

    Devolve uma coleção de Exceções ao Período para o conjunto Modulo e SubModulo existentes no período especificado

    Declaration
    BasBEPeriodoExcecoes EditaListaSubModulo(string Modulo, string SubModulo, DateTime PeriodoInicial, DateTime PeriodoFinal)
    Parameters
    Type Name Description
    System.String Modulo

    Módulo Conjunto de 3 caracteres identificativos do módulo

    System.String SubModulo

    Sub-Módulo Conjunto de 3 caracteres identificativo do sub-módulo

    System.DateTime PeriodoInicial

    Limite inferior do perído (pode ser passado CDate(0) para não limitar)

    System.DateTime PeriodoFinal

    Limite superior do perído (pode ser passado CDate(0) para não limitar)

    Returns
    Type Description
    BasBEPeriodoExcecoes

    ExisteId(String)

    Verifica se a Exceção ao Período existe.

    Declaration
    bool ExisteId(string Id)
    Parameters
    Type Name Description
    System.String Id

    Identificador da Exceção ao Período

    Returns
    Type Description
    System.Boolean

    RemoveId(String)

    Remove a Exceção ao Período

    Declaration
    void RemoveId(string Id)
    Parameters
    Type Name Description
    System.String Id

    Identificador do registo a remover

    ValidaActualizacao(BasBEPeriodoExcecao, ref String, String)

    Valida a actualização da Exceção ao Período

    Declaration
    bool ValidaActualizacao(BasBEPeriodoExcecao PeriodoExcecao, ref string Erros, string Avisos)
    Parameters
    Type Name Description
    BasBEPeriodoExcecao PeriodoExcecao

    Entidade a actualizar

    System.String Erros

    Devolve informação de erros

    System.String Avisos

    Devolve informação de avisos

    Returns
    Type Description
    System.Boolean

    ValidaActualizacaoColecao(BasBEPeriodoExcecoes, ref String, ref String)

    Valida a actualização da Exceção ao Período

    Declaration
    bool ValidaActualizacaoColecao(BasBEPeriodoExcecoes Colecao, ref string Erros, ref string Avisos)
    Parameters
    Type Name Description
    BasBEPeriodoExcecoes Colecao

    Lista de Exceções ao Periodo a validar

    System.String Erros

    Devolve informação de erros

    System.String Avisos

    Devolve informação de avisos

    Returns
    Type Description
    System.Boolean

    ValidaRemocao(String, String, String)

    Valida se é possível remover a Exceção no Período

    Declaration
    bool ValidaRemocao(string Id, string Erros, string Avisos)
    Parameters
    Type Name Description
    System.String Id
    System.String Erros

    Retorna informação dos erros quando não é possível remover

    System.String Avisos

    Retorna avisos para a remoção

    Returns
    Type Description
    System.Boolean