Interface ICblBSLiquidacaoCustos

Classe utilizada para obter serviços e regras de negócio sobre Liquidação de Custos.

Namespace: ICblBS100

Assembly: ICblBS100.dll

Syntax

[ComVisible(true)]
[Guid("617481C6-44EC-4CAB-9EAD-E66B60265FB3")]
public interface ICblBSLiquidacaoCustos

Methods

Actualiza(CblBELiquidacaoCustos)

Actualiza a informação da Liquidação de Custos

Declaration

void Actualiza(CblBELiquidacaoCustos objLiquidacaoCustos)

Parameters

Type	Name	Description
CblBELiquidacaoCustos	objLiquidacaoCustos	Objecto que contém a informação acerca da Liquidação de Custos.

Actualiza(CblBELiquidacaoCustos, ref String)

Actualiza a informação da Liquidação de Custos

Declaration

void Actualiza(CblBELiquidacaoCustos objLiquidacaoCustos, ref string Avisos)

Parameters

Type	Name	Description
CblBELiquidacaoCustos	objLiquidacaoCustos	Objecto que contém a informação acerca da Liquidação de Custos.
System.String	Avisos	Notificação devolvida pelo processo de actualização.

Actualiza(CblBELiquidacaoCustos, ref String, ref String)

Actualiza a informação da Liquidação de Custos

Declaration

void Actualiza(CblBELiquidacaoCustos objLiquidacaoCustos, ref string Avisos, ref string DescricaoDocGerado)

Parameters

Type	Name	Description
CblBELiquidacaoCustos	objLiquidacaoCustos	Objecto que contém a informação acerca da Liquidação de Custos.
System.String	Avisos	Notificação devolvida pelo processo de actualização.
System.String	DescricaoDocGerado	Descrição dos documentos gerados pelo processo de actualização.

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

Actualiza o valor de um atributo de uma Liquidação de Custos.

Declaration

void ActualizaValorAtributo(string TipoLancamento, int Ano, int Numero, string Atributo, dynamic Valor)

Parameters

Type	Name	Description
System.String	TipoLancamento	Tipo de Lançamento.
System.Int32	Ano	Exercicio.
System.Int32	Numero
System.String	Atributo	Identifica o atributo a actualizar.
System.Object	Valor	Identifica o valor a gravar no atributo seleccionado.

ActualizaValorAtributoDocumento(String, String, String, Object)

Actualiza o valor de um atributo de uma linha de documento de uma Liquidação de Custos.

Declaration

void ActualizaValorAtributoDocumento(string IDCabecDocLiq, string IDCabecMovCBL, string Atributo, dynamic Valor)

Parameters

Type	Name	Description
System.String	IDCabecDocLiq	Identificador da Liquidação de Custos.
System.String	IDCabecMovCBL	Identificador do documento contabilístico.
System.String	Atributo	Identifica o atributo a actualizar.
System.Object	Valor	Identifica o valor a gravar no atributo seleccionado.

ActualizaValorAtributoID(String, String, Object)

Actualiza o valor de um atributo de uma Liquidação de Custos.

Declaration

void ActualizaValorAtributoID(string ID, string Atributo, dynamic Valor)

Parameters

Type	Name	Description
System.String	ID	Identificador da Liquidação de Custos.
System.String	Atributo	Identifica o atributo a actualizar.
System.Object	Valor	Identifica o valor a gravar no atributo seleccionado.

ActualizaValorAtributoLinha(String, Int32, String, Object)

Actualiza o valor de um atributo de uma linha de uma Liquidação de Custos.

Declaration

void ActualizaValorAtributoLinha(string IDCabecDocLiq, int Linha, string Atributo, dynamic Valor)

Parameters

Type	Name	Description
System.String	IDCabecDocLiq	Identificador da Liquidação de Custos.
System.Int32	Linha	Número da linha.
System.String	Atributo	Identifica o atributo a actualizar.
System.Object	Valor	Identifica o valor a gravar no atributo seleccionado.

ActualizaValorAtributoLinhaID(String, String, Object)

Actualiza o valor de um atributo de uma linha de uma Liquidação de Custos.

Declaration

void ActualizaValorAtributoLinhaID(string ID, string Atributo, dynamic Valor)

Parameters

Type	Name	Description
System.String	ID	Identificador da linha.
System.String	Atributo	Identifica o atributo a actualizar.
System.Object	Valor	Identifica o valor a gravar no atributo seleccionado.

ActualizaValorAtributos(String, Int32, Int32, StdBECampos)

Actualiza o valor de um conjunto de atributos da Norma de Liquidação.

Declaration

void ActualizaValorAtributos(string TipoLancamento, int Ano, int Numero, StdBECampos Atributos)

Parameters

Type	Name	Description
System.String	TipoLancamento	Tipo de Lançamento.
System.Int32	Ano	Exercicio.
System.Int32	Numero
StdBECampos	Atributos	Identifica os atributos e os respectivos valores a actualizar.

ActualizaValorAtributosDocumento(String, String, StdBECampos)

Actualiza o valor de um conjunto de atributos de linha de documento de uma Liquidação de Custos.

Declaration

void ActualizaValorAtributosDocumento(string IDCabecDocLiq, string IDCabecMovCBL, StdBECampos Atributos)

Parameters

Type	Name	Description
System.String	IDCabecDocLiq	Identificador da Liquidação de Custos.
System.String	IDCabecMovCBL	Identificador do documento contabilístico.
StdBECampos	Atributos	Identifica os atributos e os respectivos valores a actualizar.

ActualizaValorAtributosID(String, StdBECampos)

Actualiza o valor de um conjunto de atributos da Norma de Liquidação.

Declaration

void ActualizaValorAtributosID(string ID, StdBECampos Atributos)

Parameters

Type	Name	Description
System.String	ID	Identificador da Liquidação de Custos.
StdBECampos	Atributos	Identifica os atributos e os respectivos valores a actualizar.

ActualizaValorAtributosLinha(String, Int32, StdBECampos)

Actualiza o valor de um conjunto de atributos dem uma linha de uma Liquidação de Custos.

Declaration

void ActualizaValorAtributosLinha(string IDCabecDocLiq, int Linha, StdBECampos Atributos)

Parameters

Type	Name	Description
System.String	IDCabecDocLiq	Identificador da Liquidação de Custos.
System.Int32	Linha	Número da linha.
StdBECampos	Atributos	Identifica os atributos e os respectivos valores a actualizar.

ActualizaValorAtributosLinhaID(String, StdBECampos)

Actualiza o valor de um conjunto de atributos de uma linha de uma Liquidação de Custos.

Declaration

void ActualizaValorAtributosLinhaID(string ID, StdBECampos Atributos)

Parameters

Type	Name	Description
System.String	ID	Identificador da linha.
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

DaDefCamposUtilLinhas()

Devolve as definições dos campos do utilizador das linhas de Liquidação de Custos.

Declaration

StdBEDefCamposUtil DaDefCamposUtilLinhas()

Returns

Type	Description
StdBEDefCamposUtil

DaProximoNumero(String, Int32)

Devolve o próximo número de documento a ser usado.

Declaration

int DaProximoNumero(string TipoLancamento, int Ano)

Parameters

Type	Name	Description
System.String	TipoLancamento
System.Int32	Ano

Returns

Type	Description
System.Int32

DaUltimoDiario(String, Int32)

Devolve o último diário usado.

Declaration

string DaUltimoDiario(string TipoLancamento = "", int Ano = 0)

Parameters

Type	Name	Description
System.String	TipoLancamento
System.Int32	Ano

Returns

Type	Description
System.String

DaUltimoDocumento(String, Int32)

Devolve o último documento usado.

Declaration

string DaUltimoDocumento(string TipoLancamento = "", int Ano = 0)

Parameters

Type	Name	Description
System.String	TipoLancamento
System.Int32	Ano

Returns

Type	Description
System.String

DaValorAtributo(String, Int32, Int32, String)

Devolve o valor de um atributo de uma Liquidação de Custos.

Declaration

dynamic DaValorAtributo(string TipoLancamento, int Ano, int Numero, string Atributo)

Parameters

Type	Name	Description
System.String	TipoLancamento	Tipo de Lançamento.
System.Int32	Ano	Exercicio.
System.Int32	Numero
System.String	Atributo	Identifica o atributo para o qual se pretende devolver o valor.

Returns

Type	Description
System.Object

DaValorAtributoDocumento(String, String, String)

Devolve o valor de um atributo de uma Liquidação de Custos.

Declaration

dynamic DaValorAtributoDocumento(string IDCabecDocLiq, string IDCabecMovCBL, string Atributo)

Parameters

Type	Name	Description
System.String	IDCabecDocLiq	Identifica o documento de liquidação.
System.String	IDCabecMovCBL	Identifica o movimento.
System.String	Atributo	Identifica o atributo para o qual se pretende devolver o valor.

Returns

Type	Description
System.Object

DaValorAtributoID(String, String)

Devolve o valor de um atributo de uma Liquidação de Custos.

Declaration

dynamic DaValorAtributoID(string ID, string Atributo)

Parameters

Type	Name	Description
System.String	ID	Identificador da Liquidação de Custos.
System.String	Atributo	Identifica o atributo para o qual se pretende devolver o valor.

Returns

Type	Description
System.Object

DaValorAtributoIDLock(String, String)

Devolve o valor de um atributo de uma Liquidação de Custos, respeitando os locks da base de dados.

Declaration

dynamic DaValorAtributoIDLock(string ID, string Atributo)

Parameters

Type	Name	Description
System.String	ID	Identificador da Liquidação de Custos.
System.String	Atributo	Identifica o atributo para o qual se pretende devolver o valor.

Returns

Type	Description
System.Object

DaValorAtributoLinha(String, Int32, String)

Devolve o valor de um atributo de uma linha de uma Liquidação de Custos.

Declaration

dynamic DaValorAtributoLinha(string IDCabecDocLiq, int Linha, string Atributo)

Parameters

Type	Name	Description
System.String	IDCabecDocLiq
System.Int32	Linha
System.String	Atributo	Identifica o atributo para o qual se pretende devolver o valor.

Returns

Type	Description
System.Object

DaValorAtributoLinhaID(String, String)

Devolve o valor de um atributo de uma linha de uma Liquidação de Custos.

Declaration

dynamic DaValorAtributoLinhaID(string ID, string Atributo)

Parameters

Type	Name	Description
System.String	ID	Identificador
System.String	Atributo	Identifica o atributo para o qual se pretende devolver o valor.

Returns

Type	Description
System.Object

DaValorAtributoLinhaIDLock(String, String)

Devolve o valor de um atributo de uma linha de uma Liquidação de Custos, respeitando os locks da base de dados.

Declaration

dynamic DaValorAtributoLinhaIDLock(string ID, string Atributo)

Parameters

Type	Name	Description
System.String	ID	Identificador da Liquidação de Custos.
System.String	Atributo	Identifica o atributo para o qual se pretende devolver o valor.

Returns

Type	Description
System.Object

DaValorAtributoLinhaLock(String, Int32, String)

Devolve o valor de um atributo de uma linha de uma Liquidação de Custos, respeitando os locks da base de dados.

Declaration

dynamic DaValorAtributoLinhaLock(string IDCabecDocLiq, int Linha, string Atributo)

Parameters

Type	Name	Description
System.String	IDCabecDocLiq	Identificador da Liquidação de Custos.
System.Int32	Linha	Identifica o número da linha.
System.String	Atributo	Identifica o atributo para o qual se pretende devolver o valor.

Returns

Type	Description
System.Object

DaValorAtributoLock(String, Int32, Int32, String)

Devolve o valor de um atributo de uma Liquidação de Custos, respeitando os locks da base de dados.

Declaration

dynamic DaValorAtributoLock(string TipoLancamento, int Ano, int Numero, string Atributo)

Parameters

Type	Name	Description
System.String	TipoLancamento	Tipo de Lançamento.
System.Int32	Ano	Exercicio.
System.Int32	Numero
System.String	Atributo	Identifica o atributo para o qual se pretende devolver o valor.

Returns

Type	Description
System.Object

DaValorAtributos(String, Int32, Int32, Object[])

Devolve os valores de um conjunto de atributos de uma Liquidação de Custos

Declaration

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

Parameters

Type	Name	Description
System.String	TipoLancamento	Tipo de Lançamento.
System.Int32	Ano	Exercício.
System.Int32	Numero
System.Object[]	Atributos	Atributos para os quais se pretende devolver os valores

Returns

Type	Description
StdBECampos

DaValorAtributosDocumento(String, String, Object[])

Devolve os valores de um conjunto de atributos de uma Liquidação de Custos.

Declaration

StdBECampos DaValorAtributosDocumento(string IDCabecDocLiq, string IDCabecMovCBL, params dynamic[] Atributos)

Parameters

Type	Name	Description
System.String	IDCabecDocLiq	Identifica o documento de liquidação.
System.String	IDCabecMovCBL	Identifica o movimento.
System.Object[]	Atributos	Atributos para os quais se pretende devolver os valores

Returns

Type	Description
StdBECampos

DaValorAtributosID(String, Object[])

Devolve os valores de um conjunto de atributos.

Declaration

StdBECampos DaValorAtributosID(string ID, params dynamic[] Atributos)

Parameters

Type	Name	Description
System.String	ID	Identificador da liquidação.
System.Object[]	Atributos	Atributos para os quais se pretende devolver os valores

Returns

Type	Description
StdBECampos

DaValorAtributosIDLock(String, Object[])

Devolve o valor de um conjunto de atributos de uma Liquidação de Custos, respeitando os locks da base de dados.

Declaration

StdBECampos DaValorAtributosIDLock(string ID, params dynamic[] Atributos)

Parameters

Type	Name	Description
System.String	ID	Identificador da Liquidação de Custos.
System.Object[]	Atributos	Conjunto de atributos dos quais se pretende devolver o valor.

Returns

Type	Description
StdBECampos

DaValorAtributosLinha(String, Int32, Object[])

Devolve os valores de um conjunto de atributos de um documento de Liquidação de Custos

Declaration

StdBECampos DaValorAtributosLinha(string IDCabecDocLiq, int Linha, params dynamic[] Atributos)

Parameters

Type	Name	Description
System.String	IDCabecDocLiq	Identificador do documento.
System.Int32	Linha	Número da linha para a qual se pretende devolver os valores.
System.Object[]	Atributos	Atributos para os quais se pretende devolver os valores

Returns

Type	Description
StdBECampos

DaValorAtributosLinhaID(String, Object[])

Devolve os valores de um conjunto de atributos de uma linha de Liquidação de Custos

Declaration

StdBECampos DaValorAtributosLinhaID(string ID, params dynamic[] Atributos)

Parameters

Type	Name	Description
System.String	ID	Identificador.
System.Object[]	Atributos

Returns

Type	Description
StdBECampos

DaValorAtributosLinhaIDLock(String, Object[])

Devolve o valor de um conjunto de atributos de uma linha de uma Liquidação de Custos, respeitando os locks da base de dados.

Declaration

StdBECampos DaValorAtributosLinhaIDLock(string ID, params dynamic[] Atributos)

Parameters

Type	Name	Description
System.String	ID	Identificador da Liquidação de Custos.
System.Object[]	Atributos	Conjunto de atributos dos quais se pretende devolver o valor.

Returns

Type	Description
StdBECampos

DaValorAtributosLinhaLock(String, Int32, Object[])

Devolve o valor de um conjunto de atributos de uma linha de uma Liquidação de Custos, respeitando os locks da base de dados.

Declaration

StdBECampos DaValorAtributosLinhaLock(string IDCabecDocLiq, int Linha, params dynamic[] Atributos)

Parameters

Type	Name	Description
System.String	IDCabecDocLiq	Identificador da Liquidação de Custos.
System.Int32	Linha	Identifica o número da linha.
System.Object[]	Atributos	Conjunto de atributos dos quais se pretende devolver o valor.

Returns

Type	Description
StdBECampos

DaValorAtributosLock(String, Int32, Int32, Object[])

Devolve o valor de um conjunto de atributos de uma Liquidação de Custos, respeitando os locks da base de dados.

Declaration

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

Parameters

Type	Name	Description
System.String	TipoLancamento	Tipo de Lançamento.
System.Int32	Ano	Exercicio.
System.Int32	Numero
System.Object[]	Atributos	Conjunto de atributos dos quais se pretende devolver o valor.

Returns

Type	Description
StdBECampos

Edita(String, Int32, Int32)

Devolve um objecto do tipo CblBELiquidacaoCustos contendo a toda informação acerca de uma Liquidação de Custos.

Declaration

CblBELiquidacaoCustos Edita(string TipoLancamento, int Ano, int Numero)

Parameters

Type	Name	Description
System.String	TipoLancamento	Tipo de Lançamento.
System.Int32	Ano	Exercicio.
System.Int32	Numero

Returns

Type	Description
CblBELiquidacaoCustos

EditaID(String)

Devolve um objecto do tipo CblBELiquidacaoCustos contendo a toda informação acerca de uma Liquidação de Custos.

Declaration

CblBELiquidacaoCustos EditaID(string ID)

Parameters

Type	Name	Description
System.String	ID	Identificador da Liquidação de Custos.

Returns

Type	Description
CblBELiquidacaoCustos

Existe(String, Int32, Int32)

Verifica se a liquidação existe.

Declaration

bool Existe(string TipoLancamento, int Ano, int Numero)

Parameters

Type	Name	Description
System.String	TipoLancamento	Tipo de Lançamento.
System.Int32	Ano	Exercicio.
System.Int32	Numero	Número da Liquidação de Custos.

Returns

Type	Description
System.Boolean

ExisteID(String)

Verifica se a liquidação existe.

Declaration

bool ExisteID(string ID)

Parameters

Type	Name	Description
System.String	ID	Id do documento.

Returns

Type	Description
System.Boolean

ListaDocumentosGerados(String)

Devolve lista de documentos gerados.

Declaration

CblBEDocumentosLiqCustos ListaDocumentosGerados(string IDCabecDocLiq)

Parameters

Type	Name	Description
System.String	IDCabecDocLiq

Returns

Type	Description
CblBEDocumentosLiqCustos

ListaLinhasLiquidacaoCustos(String, String)

Devolve linhas de liquidação de custos.

Declaration

CblBELinhasLiqCustos ListaLinhasLiquidacaoCustos(string IDCabecDocLiq, string IDCabecMovCBL = "")

Parameters

Type	Name	Description
System.String	IDCabecDocLiq
System.String	IDCabecMovCBL

Returns

Type	Description
CblBELinhasLiqCustos

ListaMovimentosLiquidar(CblBETipos.TParamsMovimentosLiquidar)

Devolve lista de movimentos a liquidar.

Declaration

StdBELista ListaMovimentosLiquidar(CblBETipos.TParamsMovimentosLiquidar tParams)

Parameters

Type	Name	Description
CblBETipos.TParamsMovimentosLiquidar	tParams

Returns

Type	Description
StdBELista

Remove(String, Int32, Int32)

Remove o elemento da base de dados.

Declaration

void Remove(string TipoLancamento, int Ano, int Numero)

Parameters

Type	Name	Description
System.String	TipoLancamento	Tipo de Lançamento.
System.Int32	Ano	Exercicio.
System.Int32	Numero	Número da Liquidação de Custos.

RemoveID(String)

Remove o elemento da base de dados.

Declaration

void RemoveID(string ID)

Parameters

Type	Name	Description
System.String	ID	Id do documento.

ValidaActualizacao(CblBELiquidacaoCustos)

Efectua a validação da actualização da Liquidação de Custos.

Declaration

bool ValidaActualizacao(CblBELiquidacaoCustos objLiquidacaoCustos)

Parameters

Type	Name	Description
CblBELiquidacaoCustos	objLiquidacaoCustos	Objecto que contém a informação acerca da Liquidação de Custos.

Returns

Type	Description
System.Boolean

ValidaActualizacao(CblBELiquidacaoCustos, ref String)

Efectua a validação da actualização da Liquidação de Custos.

Declaration

bool ValidaActualizacao(CblBELiquidacaoCustos objLiquidacaoCustos, ref string Erros)

Parameters

Type	Name	Description
CblBELiquidacaoCustos	objLiquidacaoCustos	Objecto que contém a informação acerca da Liquidação de Custos.
System.String	Erros	Notificação dos erros encontrados na validação.

Returns

Type	Description
System.Boolean

ValidaProcessamento(CblBELiquidacaoCustos)

Valida o processamento da Liquidação de Custos

Declaration

bool ValidaProcessamento(CblBELiquidacaoCustos objLiquidacaoCustos)

Parameters

Type	Name	Description
CblBELiquidacaoCustos	objLiquidacaoCustos	Objecto que contém a informação acerca da Liquidação de Custos.

Returns

Type	Description
System.Boolean

ValidaProcessamento(CblBELiquidacaoCustos, ref String)

Valida o processamento da Liquidação de Custos

Declaration

bool ValidaProcessamento(CblBELiquidacaoCustos objLiquidacaoCustos, ref string Avisos)

Parameters

Type	Name	Description
CblBELiquidacaoCustos	objLiquidacaoCustos	Objecto que contém a informação acerca da Liquidação de Custos.
System.String	Avisos	Notificação devolvida pelo processo de Validação.

Returns

Type	Description
System.Boolean