PRIMAVERA | Developers

    Show / Hide Table of Contents

    Interface IImoBSFichas

    Classe utilizada para obter serviços e regras de negócio sobre as Fichas.

    Namespace: IEapBS100
    Assembly: IEapBS100.dll
    Syntax
    [ComVisible(true)]
    [Guid("2651DF08-2319-4462-B330-EA024C0F7EB2")]
    public interface IImoBSFichas

    Methods

    Actualiza(ImoBEFicha)

    Actualiza a informação da Ficha.

    Declaration
    void Actualiza(ImoBEFicha objBE)
    Parameters
    Type Name Description
    ImoBEFicha objBE

    Objecto contendo a informação actualizada do Ficha.

    Actualiza(ImoBEFicha, ref String)

    Actualiza a informação da Ficha.

    Declaration
    void Actualiza(ImoBEFicha objBE, ref string Avisos)
    Parameters
    Type Name Description
    ImoBEFicha objBE

    Objecto contendo a informação actualizada do Ficha.

    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 Ficha, string Atributo, dynamic Valor)
    Parameters
    Type Name Description
    System.String Ficha

    Identificador da Ficha.

    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 Ficha, StdBECampos Atributos)
    Parameters
    Type Name Description
    System.String Ficha

    Identificador da Ficha.

    StdBECampos Atributos

    Identifica os atributos e os respectivos valores a actualizar.

    CodBarrasRepetido(String, String)

    Verifica se o código de barras já se encontra definido.

    Declaration
    bool CodBarrasRepetido(string CodigoBarras, string Ficha)
    Parameters
    Type Name Description
    System.String CodigoBarras

    Identificador do código de barras.

    System.String Ficha

    Identificador da Ficha.

    Returns
    Type Description
    System.Boolean

    CriaFicha(String, DateTime, String, Boolean, String)

    Cria uma Ficha de Imobilizado e devolve o Código da ficha.

    Declaration
    string CriaFicha(string Descricao, DateTime DataAquisicao, string CodigoFiscal, bool ActivoFixo = true, string CodigoFicha = "")
    Parameters
    Type Name Description
    System.String Descricao

    Identificador da descrição.

    System.DateTime DataAquisicao

    Identificador da data de aquisição.

    System.String CodigoFiscal

    Identificador do código fiscal.

    System.Boolean ActivoFixo

    Identificador de activo fixo.

    System.String CodigoFicha

    Identificador do código da ficha.

    Returns
    Type Description
    System.String

    CriaFicha(String, DateTime, String, Boolean, String, DateTime, DateTime, Int32, String, String, String, String, String, String, String, String)

    Cria uma Ficha de Imobilizado e devolve o Código da ficha.

    Declaration
    string CriaFicha(string Descricao, DateTime DataAquisicao, string CodigoFiscal, bool ActivoFixo, string CodigoFicha, DateTime DataUtilizacao, DateTime DataInventario, int NumeroElementos, string NumeroSerie, string NumeroInventario, string CodigoBarras, string DiplomaLegal, string TipoInvestimento, string ContaInvestimento, string Actividade, string Economica)
    Parameters
    Type Name Description
    System.String Descricao

    Identificador da descrição.

    System.DateTime DataAquisicao

    Identificador da data de aquisição.

    System.String CodigoFiscal

    Identificador do código fiscal.

    System.Boolean ActivoFixo

    Identificador de activo fixo.

    System.String CodigoFicha

    Identificador do código da ficha.

    System.DateTime DataUtilizacao

    Identificador da data de utilização.

    System.DateTime DataInventario

    Identificador da data de inventário.

    System.Int32 NumeroElementos

    Identificador do número de elementos.

    System.String NumeroSerie

    Identificador do número de série.

    System.String NumeroInventario

    Identificador do número de inventário.

    System.String CodigoBarras

    Identificador do código de barras.

    System.String DiplomaLegal

    Identificador do diploma legal.

    System.String TipoInvestimento

    Identificador do tipo de investimento.

    System.String ContaInvestimento

    Identificador da conta de investimento.

    System.String Actividade

    Identificador da código da actividade.

    System.String Economica

    Identificador da classificação económica.

    Returns
    Type Description
    System.String

    DaDefCamposUtil()

    Devolve as definições dos campos do utilizador.

    Declaration
    StdBEDefCamposUtil DaDefCamposUtil()
    Returns
    Type Description
    StdBEDefCamposUtil

    DaExercicioAquisicao(String)

    Devolve o exercício de aquisição de uma Ficha.

    Declaration
    int DaExercicioAquisicao(string Ficha)
    Parameters
    Type Name Description
    System.String Ficha

    Identificador da Ficha.

    Returns
    Type Description
    System.Int32

    DaExercicioPeriodoAquisicao(String, ref Int32, ref Int32)

    Devolve o exercício e período de aquisição de uma Ficha.

    Declaration
    void DaExercicioPeriodoAquisicao(string Ficha, ref int OutExercicioAquisicao, ref int OutPeriodoAquisicao)
    Parameters
    Type Name Description
    System.String Ficha

    Identificador da Ficha.

    System.Int32 OutExercicioAquisicao

    Identificador do exercício de aquisição.

    System.Int32 OutPeriodoAquisicao

    Identificador do período de aquisição.

    DaExercicioPeriodoAquisicaoUtilizacao(String, ref Int32, ref Int32, ref Int32, ref Int32)

    Devolve o exercício e período de aquisição e de utilização de uma Ficha.

    Declaration
    void DaExercicioPeriodoAquisicaoUtilizacao(string Ficha, ref int OutExercicioAquisicao, ref int OutPeriodoAquisicao, ref int OutExercicioUtilizacao, ref int OutPeriodoUtilizacao)
    Parameters
    Type Name Description
    System.String Ficha

    Identificador da Ficha.

    System.Int32 OutExercicioAquisicao

    Identificador do exercício de aquisição.

    System.Int32 OutPeriodoAquisicao

    Identificador do período de aquisição.

    System.Int32 OutExercicioUtilizacao

    Identificador do exercício de utilização.

    System.Int32 OutPeriodoUtilizacao

    Identificador do período de utilização

    DaExercicioPeriodoUtilizacao(String, ref Int32, ref Int32)

    Devolve o exercício e período de utilização de uma Ficha.

    Declaration
    void DaExercicioPeriodoUtilizacao(string Ficha, ref int OutExercicioUtilizacao, ref int OutPeriodoUtilizacao)
    Parameters
    Type Name Description
    System.String Ficha

    Identificador da Ficha.

    System.Int32 OutExercicioUtilizacao

    Identificador do exercício de utilização.

    System.Int32 OutPeriodoUtilizacao

    Identificador do período de utilização

    DaExercicioUtilizacao(String)

    Devolve o exercício de utilização de uma Ficha.

    Declaration
    int DaExercicioUtilizacao(string Ficha)
    Parameters
    Type Name Description
    System.String Ficha

    Identificador da Ficha.

    Returns
    Type Description
    System.Int32

    DaFichaEstados(String)

    Devolve o estado actual da Ficha (Activo, Abatida, Alienada, Sinistrada, Decomposta, Documentos Externos).

    Declaration
    StdBELista DaFichaEstados(string Ficha)
    Parameters
    Type Name Description
    System.String Ficha

    Identificador da Ficha.

    Returns
    Type Description
    StdBELista

    DaPeriodoAquisicao(String)

    Devolve o período de aquisição de uma Ficha.

    Declaration
    int DaPeriodoAquisicao(string Ficha)
    Parameters
    Type Name Description
    System.String Ficha

    Identificador da Ficha.

    Returns
    Type Description
    System.Int32

    DaPeriodoUtilizacao(String)

    Devolve o período de utilização de uma Ficha.

    Declaration
    int DaPeriodoUtilizacao(string Ficha)
    Parameters
    Type Name Description
    System.String Ficha

    Identificador da Ficha.

    Returns
    Type Description
    System.Int32

    DaProximoCodigoBarras(String, Int32, String, String)

    Retorna o proxímo código de barras.

    Declaration
    string DaProximoCodigoBarras(string CodigoBase = "", int AnoUtilizacao = 0, string Estabelecimento = "", string UtilizadorERP = "")
    Parameters
    Type Name Description
    System.String CodigoBase

    Identificador o código de referência para o próximo código.

    System.Int32 AnoUtilizacao

    Identificador do ano de utilização.

    System.String Estabelecimento

    Identificador do estabelecimento.

    System.String UtilizadorERP

    Identificador do utilizador.

    Returns
    Type Description
    System.String

    DaProximoCodigoFicha(String, Int32, String, String)

    Retorna o proxímo identificador da Ficha.

    Declaration
    string DaProximoCodigoFicha(string CodigoBase = "", int AnoUtilizacao = 0, string Estabelecimento = "", string UtilizadorERP = "")
    Parameters
    Type Name Description
    System.String CodigoBase

    Identificador o código de referência para o próximo código.

    System.Int32 AnoUtilizacao

    Identificador do ano de utilização.

    System.String Estabelecimento

    Identificador do estabelecimento.

    System.String UtilizadorERP

    Identificador do utilizador.

    Returns
    Type Description
    System.String

    DaProximoNumeroInventario(String, Int32, String, String)

    Retorna Retorna o proxímo número de inventário.

    Declaration
    string DaProximoNumeroInventario(string CodigoBase = "", int AnoUtilizacao = 0, string Estabelecimento = "", string UtilizadorERP = "")
    Parameters
    Type Name Description
    System.String CodigoBase

    Identificador o código de referência para o próximo código.

    System.Int32 AnoUtilizacao

    Identificador do ano de utilização.

    System.String Estabelecimento

    Identificador do estabelecimento.

    System.String UtilizadorERP

    Identificador do utilizador.

    Returns
    Type Description
    System.String

    DaValorAquisicao(String)

    Devolve o valor de aquisição de uma Ficha.

    Declaration
    double DaValorAquisicao(string Ficha)
    Parameters
    Type Name Description
    System.String Ficha

    Identificador da Ficha.

    Returns
    Type Description
    System.Double

    DaValorAquisicao(String, ref String)

    Devolve o valor de aquisição de uma Ficha.

    Declaration
    double DaValorAquisicao(string Ficha, ref string Plano)
    Parameters
    Type Name Description
    System.String Ficha

    Identificador da Ficha.

    System.String Plano

    Identificador da Plano (Opcional).

    Returns
    Type Description
    System.Double

    DaValorAtributo(String, String)

    Devolve o valor de um atributo.

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

    Identificador da Ficha.

    System.String Atributo

    Nome do atributo cujo valor será devolvido.

    Returns
    Type Description
    System.Object

    DaValorAtributoLock(String, String)

    Devolve o valor de um atributo, respeitando os locks da base de dados.

    Declaration
    dynamic DaValorAtributoLock(string Ficha, string Atributo)
    Parameters
    Type Name Description
    System.String Ficha

    Identificador da Ficha.

    System.String Atributo

    Nome do atributo cujo valor será devolvido.

    Returns
    Type Description
    System.Object

    DaValorAtributos(String, String[])

    Devolve o valor de um conjunto de atributos.

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

    Identificador da Ficha.

    System.String[] Atributos

    Conjunto de atributos dos quais se pretende obter o valor.

    Returns
    Type Description
    StdBECampos

    DaValorAtributosLock(String, String[])

    Devolve o valor de um conjunto de atributos, respeitando os locks da base de dados.

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

    Identificador da Ficha.

    System.String[] Atributos

    Conjunto de atributos dos quais se pretende obter o valor.

    Returns
    Type Description
    StdBECampos

    DaValorContabilistico(String)

    Devolve o valor contabilistico de uma Ficha.

    Declaration
    double DaValorContabilistico(string Ficha)
    Parameters
    Type Name Description
    System.String Ficha

    Identificador da Ficha.

    Returns
    Type Description
    System.Double

    DaValorContabilistico(String, ref String)

    Devolve o valor contabilistico de uma Ficha.

    Declaration
    double DaValorContabilistico(string Ficha, ref string Plano)
    Parameters
    Type Name Description
    System.String Ficha

    Identificador da Ficha.

    System.String Plano

    Identificador da Plano (Opcional).

    Returns
    Type Description
    System.Double

    Edita(String)

    Edita a informação da Ficha.

    Declaration
    ImoBEFicha Edita(string Ficha)
    Parameters
    Type Name Description
    System.String Ficha

    Identificador da Ficha.

    Returns
    Type Description
    ImoBEFicha

    Existe(String)

    Verifica se existe a Ficha.

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

    Identificador da Ficha.

    Returns
    Type Description
    System.Boolean

    FichaPossuiReparacoes(String)

    Verifica se a Ficha possui reparações.

    Declaration
    bool FichaPossuiReparacoes(string Ficha)
    Parameters
    Type Name Description
    System.String Ficha

    Identificador da Ficha.

    Returns
    Type Description
    System.Boolean

    GeraSqlWhereCategoriaSubQuery(String, String, String, String, String)

    Devolve uma string SQL com base nas condições existentes nos filtros da categoria das Fichas.

    Declaration
    string GeraSqlWhereCategoriaSubQuery(string TabelaPrincipal = "", string CampoPrincipal = "", string TabelaFiltro = "", string CampoFiltro = "", string Utilizador = "")
    Parameters
    Type Name Description
    System.String TabelaPrincipal

    Tabela principal da categoria.

    System.String CampoPrincipal

    Campo principal da categoria.

    System.String TabelaFiltro

    Tabela de sobre a qual será aplicada o filtro, quando diferente da tabela da categoria.

    System.String CampoFiltro

    Campo que irá filtrar os dados.

    System.String Utilizador

    Utilizador aos quais estão associadados os filtros da categoria, quando diferente do utilizador de Contexto.

    Returns
    Type Description
    System.String

    ListaAnaliseContabilisticaFiscal(String, Int32, String, Int32)

    Devolve a Lista da Análise Contabilística Fiscal.

    Declaration
    StdBELista ListaAnaliseContabilisticaFiscal(string Plano, int Tipo, string Grupo, int Exercicio)
    Parameters
    Type Name Description
    System.String Plano

    Identificador da Plano de Depreciação.

    System.Int32 Tipo

    Identificador do tipo de análise.

    System.String Grupo

    Identificador da restrição do tipo de análise.

    System.Int32 Exercicio

    Identificador do Exercício em análise.

    Returns
    Type Description
    StdBELista

    ListaAnaliseContabilisticaFiscal(String, Int32, String, Int32, ref String)

    Devolve a Lista da Análise Contabilística Fiscal.

    Declaration
    StdBELista ListaAnaliseContabilisticaFiscal(string Plano, int Tipo, string Grupo, int Exercicio, ref string Restricao)
    Parameters
    Type Name Description
    System.String Plano

    Identificador da Plano de Depreciação.

    System.Int32 Tipo

    Identificador do tipo de análise.

    System.String Grupo

    Identificador da restrição do tipo de análise.

    System.Int32 Exercicio

    Identificador do Exercício em análise.

    System.String Restricao

    Restrição a aplicar à lista.

    Returns
    Type Description
    StdBELista

    ListaAvaliacaoPatrimonial(String)

    Devolve a Lista das Mais Valias Reinvestidas.

    Declaration
    StdBELista ListaAvaliacaoPatrimonial(string Plano)
    Parameters
    Type Name Description
    System.String Plano

    Identificador da Plano de Depreciação.

    Returns
    Type Description
    StdBELista

    ListaAvaliacaoPatrimonial(String, ref String)

    Devolve a Lista das Mais Valias Reinvestidas.

    Declaration
    StdBELista ListaAvaliacaoPatrimonial(string Plano, ref string Restricao)
    Parameters
    Type Name Description
    System.String Plano

    Identificador da Plano de Depreciação.

    System.String Restricao

    Restrição a aplicar à lista.

    Returns
    Type Description
    StdBELista

    ListaFichasReparacoes(String, Boolean)

    Devolve a Lista das Fichas que são reparações.

    Declaration
    StdBELista ListaFichasReparacoes(string Ficha, bool ApresentaFichasDecompostas = true)
    Parameters
    Type Name Description
    System.String Ficha

    Identificador da Ficha.

    System.Boolean ApresentaFichasDecompostas

    Restrição de apresentação de fichas decompostas.

    Returns
    Type Description
    StdBELista

    ListaMaisValiasReinvestidas(Int32, Int32, String)

    Devolve a Lista das Mais Valias Reinvestidas..

    Declaration
    StdBELista ListaMaisValiasReinvestidas(int ExercicioInicial, int ExercicioFinal, string Restricao = "")
    Parameters
    Type Name Description
    System.Int32 ExercicioInicial

    Identificador do Exercício de início da análise.

    System.Int32 ExercicioFinal

    Identificador do Exercício de fim da análise.

    System.String Restricao

    Restrição a aplicar à lista.

    Returns
    Type Description
    StdBELista

    ListaVariacaoTaxas(String, Int32, String)

    Devolve a Lista das Mais Valias Reinvestidas - Planos Fiscais (Taxa de Depreciação).

    Declaration
    StdBELista ListaVariacaoTaxas(string Plano, int ExercicioInicial, string Restricao = "")
    Parameters
    Type Name Description
    System.String Plano

    Identificador da Plano de Depreciação.

    System.Int32 ExercicioInicial

    Identificador do Exercício de início da análise.

    System.String Restricao

    Restrição a aplicar à lista.

    Returns
    Type Description
    StdBELista

    ListaVariacaoVidaUtil(String, Int32, String)

    Devolve a Lista das Mais Valias Reinvestidas - Planos Contabilísticos (Vida Útil).

    Declaration
    StdBELista ListaVariacaoVidaUtil(string Plano, int ExercicioInicial, string Restricao = "")
    Parameters
    Type Name Description
    System.String Plano

    Identificador da Plano de Depreciação.

    System.Int32 ExercicioInicial

    Identificador do Exercício de início da análise.

    System.String Restricao

    Restrição a aplicar à lista.

    Returns
    Type Description
    StdBELista

    NumInventarioRepetido(String, String)

    Verifica se o número de inventário já se encontra definido.

    Declaration
    bool NumInventarioRepetido(string NumInventario, string Ficha)
    Parameters
    Type Name Description
    System.String NumInventario

    Identificador do número de inventário.

    System.String Ficha

    Identificador da Ficha.

    Returns
    Type Description
    System.Boolean

    Remove(String)

    Remove a Ficha.

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

    Identificador da Ficha.

    ValidaActualizacao(ImoBEFicha, ref String)

    Efectua a validação da informação do Ficha.

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

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

    System.String ErroValidacao

    Recebe a descrição de eventuais erros detectados.

    Returns
    Type Description
    System.Boolean

    ValidaOperacaoCategoria(String, ref String, Int32)

    Devolve se o utilizador actual tem acesso a uma determinada Ficha, analisando os filtros da categoria.

    Declaration
    bool ValidaOperacaoCategoria(string Ficha, ref string MsgErro, int Linha = -1)
    Parameters
    Type Name Description
    System.String Ficha

    Identificador da Ficha.

    System.String MsgErro

    Mensagem de erro devolvida pela função.

    System.Int32 Linha

    Número da linha.

    Returns
    Type Description
    System.Boolean

    ValidaRemocao(String, ref String)

    Efectua as validações necessárias à remoção do Ficha.

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

    Identificador da Ficha.

    System.String ErroValidacao

    Recebe a descrição de eventuais erros detectados.

    Returns
    Type Description
    System.Boolean