Interface ICblBSPlanoIVA

Classe utilizada para obter serviços e regras de negócio sobre Planos de IVA.

Namespace: ICblBS100

Assembly: ICblBS100.dll

Syntax

[ComVisible(true)]
[Guid("40DC4F26-68AB-4647-A001-574D8E40434F")]
public interface ICblBSPlanoIVA

Methods

Actualiza(CblBEIVA)

Actualiza a informação do Plano do IVA.

Declaration

void Actualiza(CblBEIVA objBEIva)

Parameters

Type	Name	Description
CblBEIVA	objBEIva	Objecto contendo a informação actualizada do Plano do IVA.

Actualiza(CblBEIVA, ref String)

Actualiza a informação do Plano do IVA.

Declaration

void Actualiza(CblBEIVA objBEIva, ref string Avisos)

Parameters

Type	Name	Description
CblBEIVA	objBEIva	Objecto contendo a informação actualizada do Plano do IVA.
System.String	Avisos	Notificação devolvida pelo processo de actualização.

ActualizaValorAtributo(Int32, String, String, Object)

Actualiza o valor de um atributo.

Declaration

void ActualizaValorAtributo(int Ano, string Iva, string Atributo, dynamic Valor)

Parameters

Type	Name	Description
System.Int32	Ano	Identificador do Ano.
System.String	Iva	Identificador do Plano de IVA.
System.String	Atributo	Nome do atributo cujo valor será actualizado.
System.Object	Valor	Valor do atributo que será actualizado.

ActualizaValorAtributos(Int32, String, StdBECampos)

Actualiza os valores respectivos de um conjunto de atributos.

Declaration

void ActualizaValorAtributos(int Ano, string Iva, StdBECampos Atributos)

Parameters

Type	Name	Description
System.Int32	Ano	Identificador do Ano.
System.String	Iva	Identificador do Plano de IVA.
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

DaDescricao(Int32, String)

Descrição associada ao Plano de IVA.

Declaration

string DaDescricao(int Ano, string Iva)

Parameters

Type	Name	Description
System.Int32	Ano	Identificador do Ano.
System.String	Iva	Identificador do Plano do IVA.

Returns

Type	Description
System.String

DaValorAtributo(Int32, String, String)

Devolve o valor de um atributo.

Declaration

dynamic DaValorAtributo(int Ano, string Iva, string Atributo)

Parameters

Type	Name	Description
System.Int32	Ano	Identificador do Ano.
System.String	Iva	Identificador do Plano de IVA.
System.String	Atributo	Nome do atributo cujo valor será devolvido.

Returns

Type	Description
System.Object

DaValorAtributoLock(Int32, String, String)

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

Declaration

dynamic DaValorAtributoLock(int Ano, string Iva, string Atributo)

Parameters

Type	Name	Description
System.Int32	Ano	Identificador do Ano.
System.String	Iva	Identificador do Plano de IVA.
System.String	Atributo	Nome do atributo cujo valor será devolvido.

Returns

Type	Description
System.Object

DaValorAtributos(Int32, String, Object[])

Devolve o valor de um conjunto de atributos.

Declaration

StdBECampos DaValorAtributos(int Ano, string Iva, params dynamic[] Atributos)

Parameters

Type	Name	Description
System.Int32	Ano	Identificador do Ano.
System.String	Iva	Identificador do Plano de IVA.
System.Object[]	Atributos	Conjunto de atributos dos quais se pretende devolver o valor.

Returns

Type	Description
StdBECampos

DaValorAtributosArray(Int32, String, String[])

Devolve o valor de um conjunto de atributos através de um array, utilizada na validação do documento.

Declaration

StdBECampos DaValorAtributosArray(int Ano, string Iva, string[] Atributos)

Parameters

Type	Name	Description
System.Int32	Ano	Identificador do Ano.
System.String	Iva
System.String[]	Atributos	Conjunto de atributos dos quais se pretende devolver o valor.

Returns

Type	Description
StdBECampos

DaValorAtributosLock(Int32, String, Object[])

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

Declaration

StdBECampos DaValorAtributosLock(int Ano, string Iva, params dynamic[] Atributos)

Parameters

Type	Name	Description
System.Int32	Ano	Identificador do Ano.
System.String	Iva	Identificador do Plano de IVA.
System.Object[]	Atributos	Conjunto de atributos dos quais se pretende devolver o valor.

Returns

Type	Description
StdBECampos

Edita(Int32, String)

Edita a informação do Plano do IVA.

Declaration

CblBEIVA Edita(int Ano, string Iva)

Parameters

Type	Name	Description
System.Int32	Ano	Identificador do Ano.
System.String	Iva	Identificador do Plano de IVA.

Returns

Type	Description
CblBEIVA

Existe(Int32, String)

Verifica se existe o Plano de IVA.

Declaration

bool Existe(int Ano, string Iva)

Parameters

Type	Name	Description
System.Int32	Ano	Identificador do Ano.
System.String	Iva	Identificador do Plano de IVA.

Returns

Type	Description
System.Boolean

ExisteClasseIVALancamento(Int32, String, ref String)

Verifica se determinada classe do I.V.A. existe e devolve o tipo de conta.

Declaration

bool ExisteClasseIVALancamento(int Ano, string Iva, ref string TipoConta)

Parameters

Type	Name	Description
System.Int32	Ano	Identificador do Ano.
System.String	Iva
System.String	TipoConta	Tipo de conta M, I ou R

Returns

Type	Description
System.Boolean

GeraSqlWhereCategoriaSubQuery()

Devolve uma string SQL com base nas condições existentes nos filtros da categoria Plano de IVA.

Declaration

string GeraSqlWhereCategoriaSubQuery()

Returns

Type	Description
System.String

GeraSqlWhereCategoriaSubQuery(ref String)

Devolve uma string SQL com base nas condições existentes nos filtros da categoria Plano de IVA.

Declaration

string GeraSqlWhereCategoriaSubQuery(ref string TabelaPrincipal)

Parameters

Type	Name	Description
System.String	TabelaPrincipal	Tabela principal da categoria.

Returns

Type	Description
System.String

GeraSqlWhereCategoriaSubQuery(ref String, ref String)

Devolve uma string SQL com base nas condições existentes nos filtros da categoria Plano de IVA.

Declaration

string GeraSqlWhereCategoriaSubQuery(ref string TabelaPrincipal, ref string CampoPrincipal)

Parameters

Type	Name	Description
System.String	TabelaPrincipal	Tabela principal da categoria.
System.String	CampoPrincipal	Campo principal da categoria.

Returns

Type	Description
System.String

GeraSqlWhereCategoriaSubQuery(ref String, ref String, ref String)

Devolve uma string SQL com base nas condições existentes nos filtros da categoria Plano de IVA.

Declaration

string GeraSqlWhereCategoriaSubQuery(ref string TabelaPrincipal, ref string CampoPrincipal, ref string TabelaFiltro)

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.

Returns

Type	Description
System.String

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

Devolve uma string SQL com base nas condições existentes nos filtros da categoria Plano de IVA.

Declaration

string GeraSqlWhereCategoriaSubQuery(ref string TabelaPrincipal, ref string CampoPrincipal, ref string TabelaFiltro, ref string CampoFiltro)

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.

Returns

Type	Description
System.String

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

Devolve uma string SQL com base nas condições existentes nos filtros da categoria Plano de IVA.

Declaration

string GeraSqlWhereCategoriaSubQuery(ref string TabelaPrincipal, ref string CampoPrincipal, ref string TabelaFiltro, ref 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

IdentificaDocumentoRegularizar(Int32, String)

Identifica se a classe de IVA está configurada para identificar um documento a regularizar.

Declaration

bool IdentificaDocumentoRegularizar(int Ano, string IVA)

Parameters

Type	Name	Description
System.Int32	Ano	Ano.
System.String	IVA

Returns

Type	Description
System.Boolean

LstPlanoIva()

Devolve a listagem dos Planos do IVA.

Declaration

StdBELista LstPlanoIva()

Returns

Type	Description
StdBELista

Remove(Int32, String)

Remove o Plano de IVA.

Declaration

void Remove(int Ano, string Iva)

Parameters

Type	Name	Description
System.Int32	Ano	Identificador do Ano.
System.String	Iva	Identificador do Plano de IVA.

ValidaActualizacao(CblBEIVA, ref String)

Efectua a validação da informação do Plano do IVA.

Declaration

bool ValidaActualizacao(CblBEIVA BEIva, ref string StrErro)

Parameters

Type	Name	Description
CblBEIVA	BEIva	Objecto contendo a informação que se pretende validar.
System.String	StrErro

Returns

Type	Description
System.Boolean

ValidaOperacaoCategoria(Int32, String, ref String, Int32)

Devolve se o utilizador actual tem acesso a uma determinada classe do Plano de IVA, analisando os filtros da categoria.

Declaration

bool ValidaOperacaoCategoria(int Ano, string Iva, ref string MsgErro, int Linha = -1)

Parameters

Type	Name	Description
System.Int32	Ano	Ano.
System.String	Iva
System.String	MsgErro
System.Int32	Linha	Número da linha.

Returns

Type	Description
System.Boolean

ValidaRemocao(Int32, String, ref String)

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

Declaration

bool ValidaRemocao(int Ano, string Iva, ref string StrErro)

Parameters

Type	Name	Description
System.Int32	Ano	Identificador do Ano.
System.String	Iva	Identificador do Plano de IVA.
System.String	StrErro

Returns

Type	Description
System.Boolean