Interface ICblBSDocumentosControlling

Classe que contém todas as obrigações associadas à entidade Documentos de Controlling.

Namespace: ICblBS100

Assembly: ICblBS100.dll

Syntax

[ComVisible(true)]
[Guid("9407FDC0-111A-45FC-992A-0D63F6157D73")]
public interface ICblBSDocumentosControlling

Methods

Actualiza(CblBEDocumentoControlling)

Actualiza a informação do Documento de Controlling .

Declaration

bool Actualiza(CblBEDocumentoControlling objDoc)

Parameters

Type	Name	Description
CblBEDocumentoControlling	objDoc

Returns

Type	Description
System.Boolean

Actualiza(CblBEDocumentoControlling, ref String)

Actualiza a informação do Documento de Controlling .

Declaration

bool Actualiza(CblBEDocumentoControlling objDoc, ref string strAvisos)

Parameters

Type	Name	Description
CblBEDocumentoControlling	objDoc
System.String	strAvisos

Returns

Type	Description
System.Boolean

ActualizaNumerador(Int32, String, String, Int32)

Actualiza Numerador dos Documentos de Controlling .

Declaration

void ActualizaNumerador(int Ano, string TipoLancamento, string Documento, int Numero)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do Numerador.
System.String	TipoLancamento	Tipo de Lançamento.
System.String	Documento	Identificação do tipo de documento.
System.Int32	Numero	Valor actualizado do Numerador.

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

Actualiza o valor de um atributo.

Declaration

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

Parameters

Type	Name	Description
System.Int32	Ano	Identificador do Ano.
System.String	Documento	Identificador do Documento.
System.String	TipoLancamento	Identificador do Tipo de Lançamento.
System.Int32	Numero	Número do Documento.
System.String	Atributo	Nome do atributo cujo valor será actualizado.
System.Object	Valor	Valor do atributo que será actualizado.

ActualizaValorAtributos(Int32, String, String, Int32, StdBECampos)

Actualiza os valores respectivos de um conjunto de atributos.

Declaration

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

Parameters

Type	Name	Description
System.Int32	Ano	Identificador do Ano.
System.String	Documento	Identificador do Documento.
System.String	TipoLancamento	Identificador do Tipo de Lançamento.
System.Int32	Numero	Número do Documento.
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 do documento.

Declaration

StdBEDefCamposUtil DaDefCamposUtilLinhas()

Returns

Type	Description
StdBEDefCamposUtil

DaNumerador(Int32, String, String)

Dá Numerador para o próximo Documento de Controlling .

Declaration

int DaNumerador(int Ano, string TipoLancamento, string Documento)

Parameters

Type	Name	Description
System.Int32	Ano	Ano do Numerador.
System.String	TipoLancamento	Tipo de Lançamento.
System.String	Documento	Identificação do tipo de documento.

Returns

Type	Description
System.Int32

DaValorAtributo(Int32, String, String, Int32, String)

Devolve o valor de um atributo.

Declaration

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

Parameters

Type	Name	Description
System.Int32	Ano	Identificador do Ano.
System.String	Documento	Identificador do Documento.
System.String	TipoLancamento	Identificador do Tipo de Lançamento.
System.Int32	Numero	Número do Documento.
System.String	Atributo	Nome do atributo cujo valor será devolvido.

Returns

Type	Description
System.Object

DaValorAtributoLock(Int32, String, String, Int32, String)

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

Declaration

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

Parameters

Type	Name	Description
System.Int32	Ano	Identificador do Ano.
System.String	Documento	Identificador do Documento.
System.String	TipoLancamento	Identificador do Tipo de Lançamento.
System.Int32	Numero	Número do Documento.
System.String	Atributo	Nome do atributo cujo valor será devolvido.

Returns

Type	Description
System.Object

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

Devolve o valor de um conjunto de atributos.

Declaration

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

Parameters

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

Returns

Type	Description
StdBECampos

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

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

Declaration

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

Parameters

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

Returns

Type	Description
StdBECampos

DocumentoEstorno(String)

Verifica se o documento Id é de um documento de estorno.

Declaration

string DocumentoEstorno(string IdDoc)

Parameters

Type	Name	Description
System.String	IdDoc	Id dodocumento a verificar se é um estorno.

Returns

Type	Description
System.String

Edita(Int32, String, String, Int32)

Edita a informação do Documento.

Declaration

CblBEDocumentoControlling Edita(int Ano, string Documento, string TipoLancamento, int Numero)

Parameters

Type	Name	Description
System.Int32	Ano	Identificador do Ano.
System.String	Documento	Identificador do Documento.
System.String	TipoLancamento	Identificador do Tipo de Lançamento.
System.Int32	Numero	Número do Documento.

Returns

Type	Description
CblBEDocumentoControlling

EstornaDocumento(CblBEDocumentoControlling)

Estorna o Documento de Controlling .

Declaration

CblBEDocumentoControlling EstornaDocumento(CblBEDocumentoControlling objDoc)

Parameters

Type	Name	Description
CblBEDocumentoControlling	objDoc	Objecto contendo a informação do Documento a estornar.

Returns

Type	Description
CblBEDocumentoControlling

EstornaDocumento(CblBEDocumentoControlling, ref String)

Estorna o Documento de Controlling .

Declaration

CblBEDocumentoControlling EstornaDocumento(CblBEDocumentoControlling objDoc, ref string strAvisos)

Parameters

Type	Name	Description
CblBEDocumentoControlling	objDoc	Objecto contendo a informação do Documento a estornar.
System.String	strAvisos

Returns

Type	Description
CblBEDocumentoControlling

Existe(Int32, String, String, Int32)

Verifica se existe o Documento.

Declaration

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

Parameters

Type	Name	Description
System.Int32	Ano	Identificador do Ano.
System.String	Documento	Identificador do Documento.
System.String	TipoLancamento	Identificador do Tipo de Lançamento.
System.Int32	Numero	Número do Documento.

Returns

Type	Description
System.Boolean

Remove(Int32, String, String, Int32)

Remove o Documento.

Declaration

bool Remove(int Ano, string Documento, string TipoLancamento, int Numero)

Parameters

Type	Name	Description
System.Int32	Ano	Identificador do Ano.
System.String	Documento	Identificador do Documento.
System.String	TipoLancamento	Identificador do Tipo de Lançamento.
System.Int32	Numero	Número do Documento.

Returns

Type	Description
System.Boolean

ValidaActualizacao(CblBEDocumentoControlling, ref String)

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

Declaration

bool ValidaActualizacao(CblBEDocumentoControlling ObjBeDocControlling, ref string StrErro)

Parameters

Type	Name	Description
CblBEDocumentoControlling	ObjBeDocControlling
System.String	StrErro

Returns

Type	Description
System.Boolean

ValidaEstorno(CblBEDocumentoControlling, ref String)

Estorna o Documento de Controlling .

Declaration

bool ValidaEstorno(CblBEDocumentoControlling ObjBeDocControlling, ref string StrErro)

Parameters

Type	Name	Description
CblBEDocumentoControlling	ObjBeDocControlling	Objecto contendo a informação do Documento a estornar.
System.String	StrErro

Returns

Type	Description
System.Boolean

ValidaRemocao(Int32, String, String, Int32, ref String)

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

Declaration

bool ValidaRemocao(int Ano, string Documento, string TipoLancamento, int Numero, ref string ErroValidacao)

Parameters

Type	Name	Description
System.Int32	Ano	Identificador do Ano.
System.String	Documento	Identificador do Documento.
System.String	TipoLancamento	Identificador do Tipo de Lançamento.
System.Int32	Numero	Número do Documento.
System.String	ErroValidacao	Recebe a descrição de eventuais erros detectados.

Returns

Type	Description
System.Boolean