Interface ICmpBSTabCompras

Classe que implementa as regras de negócio sobre a tabela dos documentos de compra.

Namespace: ICmpBS100

Assembly: ICmpBS100.dll

Syntax

[ComVisible(true)]
[Guid("B5BCACD8-1E2F-43FC-92AB-38F022DACD58")]
public interface ICmpBSTabCompras

Methods

Actualiza(CmpBETabCompra)

Actualiza um documento de compra.

Declaration

void Actualiza(CmpBETabCompra clsTabCompra)

Parameters

Type	Name	Description
CmpBETabCompra	clsTabCompra	Objecto que identifica o documento de compra.

Actualiza(CmpBETabCompra, ref String)

Actualiza um documento de compra.

Declaration

void Actualiza(CmpBETabCompra clsTabCompra, ref string strAvisos)

Parameters

Type	Name	Description
CmpBETabCompra	clsTabCompra	Objecto que identifica o documento de compra.
System.String	strAvisos	Devolve as mensagens de aviso encontradas durante a atualização.

ActualizaDataDoc(String, DateTime)

Actualiza a data do documento

Declaration

void ActualizaDataDoc(string TipoDoc, DateTime Data)

Parameters

Type	Name	Description
System.String	TipoDoc	Identificador do Código do Tipo de Documento de Compra.
System.DateTime	Data	Identificador da Data do Documento.

ActualizaPeriodo(String, DateTime, DateTime)

Actualiza um periodo bloqueado para o documento seleccionado.

Declaration

void ActualizaPeriodo(string strDocumento, DateTime datDataInicial, DateTime datDataFinal)

Parameters

Type	Name	Description
System.String	strDocumento
System.DateTime	datDataInicial
System.DateTime	datDataFinal

ActualizaValorAtributo(String, String, Object)

Atualiza o valor de um atributo.

Declaration

void ActualizaValorAtributo(string Documento, string Atributo, dynamic Valor)

Parameters

Type	Name	Description
System.String	Documento	Identifica o documento de compras.
System.String	Atributo	Nome do atributo.
System.Object	Valor	Valor do atributo.

ActualizaValorAtributos(String, StdBECampos)

Atualiza os valores de um conjunto de atributos.

Declaration

void ActualizaValorAtributos(string Documento, StdBECampos Atributos)

Parameters

Type	Name	Description
System.String	Documento	Identifica o documento de compras.
StdBECampos	Atributos	Coleção com os atributos e respetivos valores.

DaDefCamposUtil()

Devolve as definições dos campos do Utilizador.

Declaration

StdBEDefCamposUtil DaDefCamposUtil()

Returns

Type	Description
StdBEDefCamposUtil	Coleção com as definições.

DaNaturezaDoc(String)

Devolve a natureza de um determinado documento

Declaration

string DaNaturezaDoc(string TipoDocumento)

Parameters

Type	Name	Description
System.String	TipoDocumento	Identificador do Código do Tipo de Documento de Compra.

Returns

Type	Description
System.String

DaValorAtributo(String, String)

Devolve o valor de um atributo.

Declaration

dynamic DaValorAtributo(string Documento, string Atributo)

Parameters

Type	Name	Description
System.String	Documento	Identifica o documento de compras.
System.String	Atributo	Nome do atributo.

Returns

Type	Description
System.Object	Valor identificado pelo atributo.

DaValorAtributoLock(String, String)

Devolve o valor de um atributo.

Declaration

dynamic DaValorAtributoLock(string Documento, string Atributo)

Parameters

Type	Name	Description
System.String	Documento	Identifica o documento de compras.
System.String	Atributo	Nome do atributo.

Returns

Type	Description
System.Object	Valor identificado pelo atributo.

Remarks

O sufixo "Lock" indica que os valores serão obtidos a partir da cache de sistema.

DaValorAtributos(String, String[])

Devolve os valores de um conjunto de atributos.

Declaration

StdBECampos DaValorAtributos(string Documento, params string[] Atributos)

Parameters

Type	Name	Description
System.String	Documento	Identifica o documento de compras.
System.String[]	Atributos	Array com os nomes dos atributos.

Returns

Type	Description
StdBECampos	Coleção com os valores identificados pelos atributos.

DaValorAtributosLock(String, String[])

Devolve os valores de um conjunto de atributos.

Declaration

StdBECampos DaValorAtributosLock(string Documento, params string[] Atributos)

Parameters

Type	Name	Description
System.String	Documento	Identifica o documento de compras.
System.String[]	Atributos	Array com os nomes dos atributos.

Returns

Type	Description
StdBECampos	Coleção com os valores identificados pelos atributos.

Remarks

O sufixo "Lock" indica que os valores serão obtidos a partir da cache de sistema.

DocMovimentado(String)

Método que permite verificar se um determinado documento já foi movimentado

Declaration

bool DocMovimentado(string Documento)

Parameters

Type	Name	Description
System.String	Documento	Identifica o documento

Returns

Type	Description
System.Boolean

Edita(String)

Edita a configuração de um documento de compra.

Declaration

CmpBETabCompra Edita(string Documento)

Parameters

Type	Name	Description
System.String	Documento	Código do documento.

Returns

Type	Description
CmpBETabCompra	Objecto que representa a configuração do documento de compra.

Existe(String)

Indica se um documento de compra existe.

Declaration

bool Existe(string Documento)

Parameters

Type	Name	Description
System.String	Documento	Código do documento.

Returns

Type	Description
System.Boolean	True - Existe; False - Não existe

ExistemDocumentosCertificados(String)

Indica se existem já documento certificados (assinados digitalmente)

Declaration

bool ExistemDocumentosCertificados(string TipoDoc)

Parameters

Type	Name	Description
System.String	TipoDoc	Identifica o documento.

Returns

Type	Description
System.Boolean

ExistePeriodo(String, DateTime, DateTime)

Verifica se existe algum periodo bloqueado para o documento seleccionado.

Declaration

bool ExistePeriodo(string strDocumento, DateTime datDataInicial, DateTime datDataFinal)

Parameters

Type	Name	Description
System.String	strDocumento
System.DateTime	datDataInicial
System.DateTime	datDataFinal

Returns

Type	Description
System.Boolean

LstPeriodos(String)

Devolve uma lista com todos os periodos encerrados.

Declaration

StdBELista LstPeriodos(string strDocumento)

Parameters

Type	Name	Description
System.String	strDocumento	Identifica o documento.

Returns

Type	Description
StdBELista

LstTodosDocCompras()

Devolve uma lista com todos os código dos tipos de documento de Compras.

Declaration

StdBELista LstTodosDocCompras()

Returns

Type	Description
StdBELista

PeriodoBloqueado(String, DateTime)

Verifica se existe algum periodo encerrado para o documento e data.

Declaration

bool PeriodoBloqueado(string strDocumento, DateTime datData)

Parameters

Type	Name	Description
System.String	strDocumento	Identifica o documento.
System.DateTime	datData	Identifica a data do documento.

Returns

Type	Description
System.Boolean

Remove(String)

Remove um documento de compra.

Declaration

void Remove(string Documento)

Parameters

Type	Name	Description
System.String	Documento	Código do documento.

RemovePeriodo(String, DateTime, DateTime)

Remove um período bloqueado para o documento seleccionado.

Declaration

void RemovePeriodo(string strDocumento, DateTime datDataInicial, DateTime datDataFinal)

Parameters

Type	Name	Description
System.String	strDocumento
System.DateTime	datDataInicial
System.DateTime	datDataFinal

RemoveTodosPeriodos(String)

Remove todos os períodos encerrados.

Declaration

void RemoveTodosPeriodos(string strDocumento)

Parameters

Type	Name	Description
System.String	strDocumento	Identifica o documento.

ValidaActualizacao(CmpBETabCompra, ref String)

Efectua as validações necessárias à actualização do documento de compra.

Declaration

bool ValidaActualizacao(CmpBETabCompra clsTabCompra, ref string StrErro)

Parameters

Type	Name	Description
CmpBETabCompra	clsTabCompra	Objecto que identifica o documento de compra a ser validado.
System.String	StrErro	Devolve os erros encontrados.

Returns

Type	Description
System.Boolean	True - Validação com sucesso; False - Validação com erros

ValidaActualizacao(CmpBETabCompra, ref String, ref String)

Efectua as validações necessárias à actualização do documento de compra.

Declaration

bool ValidaActualizacao(CmpBETabCompra clsTabCompra, ref string StrErro, ref string strAvisos)

Parameters

Type	Name	Description
CmpBETabCompra	clsTabCompra	Objecto que identifica o documento de compra a ser validado.
System.String	StrErro	Devolve os erros encontrados.
System.String	strAvisos	Devolve as mensagens de aviso encontradas durante a validação.

Returns

Type	Description
System.Boolean	True - Validação com sucesso; False - Validação com erros

ValidaActualizacaoPeriodo(DateTime, DateTime, ref String)

Valida a actualização de periodos encerrados.

Declaration

bool ValidaActualizacaoPeriodo(DateTime datDataInicio, DateTime datDataFim, ref string StrErro)

Parameters

Type	Name	Description
System.DateTime	datDataInicio	Identifica o inicio do periodo.
System.DateTime	datDataFim	Identifica o final do periodo.
System.String	StrErro	Devolve os erros encontrados.

Returns

Type	Description
System.Boolean	True - Validação com sucesso; False - Validação com erros

ValidaRemocao(String, String)

Efectua todas as validações necessárias na remoção de um documento de compra.

Declaration

bool ValidaRemocao(string Documento, string StrErro)

Parameters

Type	Name	Description
System.String	Documento	Identifica o documento de compras.
System.String	StrErro	Devolve os erros encontrados.

Returns

Type	Description
System.Boolean	True - Validação com sucesso; False - Validação com erros