Interface IInvBSTabComposicoes

Classe que implementa as regras de negócio sobre os documentos de composição e decomposição de artigos.

Namespace: IInvBS100

Assembly: IInvBS100.dll

Syntax

[ComVisible(true)]
[Guid("35797866-F781-4E77-98E4-3A36A58A9178")]
public interface IInvBSTabComposicoes

Methods

Actualiza(InvBETabComposicao, String)

Actualiza um documento.

Declaration

void Actualiza(InvBETabComposicao Documento, string Avisos = "")

Parameters

Type	Name	Description
InvBETabComposicao	Documento	Objecto identifica o documento.
System.String	Avisos	Mensagens de aviso devolvidas.

ActualizaPeriodo(String, DateTime, DateTime)

Actualiza o bloqueio de um período de um documento.

Declaration

void ActualizaPeriodo(string Documento, DateTime DataInicial, DateTime DataFinal)

Parameters

Type	Name	Description
System.String	Documento	Código do documento (Documento).
System.DateTime	DataInicial	Data inicial do período.
System.DateTime	DataFinal	Data final do período.

ActualizaValorAtributo(String, String, Object)

Actualiza o valor de um atributo do documento.

Declaration

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

Parameters

Type	Name	Description
System.String	Documento	Código do documento (Documento).
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	Código do documento (Documento).
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.

DaDescricao(String)

Devolve a descrição de um documento.

Declaration

string DaDescricao(string Documento)

Parameters

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

Returns

Type	Description
System.String	Descrição do documento (Descricao).

DaValorAtributo(String, String)

Devolve o valor de um atributo.

Declaration

dynamic DaValorAtributo(string Documento, string Atributo)

Parameters

Type	Name	Description
System.String	Documento	Código do documento (Documento).
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	Código do documento (Documento).
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 um conjunto de valores.

Declaration

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

Parameters

Type	Name	Description
System.String	Documento	Código do documento (Documento).
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 um conjunto de valores.

Declaration

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

Parameters

Type	Name	Description
System.String	Documento	Código do documento (Documento).
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)

Indica se o documento já foi movimentado.

Declaration

bool DocMovimentado(string Documento)

Parameters

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

Returns

Type	Description
System.Boolean	True - Com movimentos; False - Sem movimentos

Edita(String)

Edita um documento.

Declaration

InvBETabComposicao Edita(string Documento)

Parameters

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

Returns

Type	Description
InvBETabComposicao	Objeto que representa o documento.

Existe(String)

Indica se um documento existe.

Declaration

bool Existe(string Documento)

Parameters

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

Returns

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

ExistePeriodo(String, DateTime, DateTime)

Indica se existe um período bloqueado de um documento nas datas indicadas.

Declaration

bool ExistePeriodo(string Documento, DateTime DataInicial, DateTime DataFinal)

Parameters

Type	Name	Description
System.String	Documento	Código do documento (Documento).
System.DateTime	DataInicial	Data inicial do período.
System.DateTime	DataFinal	Data final do período.

Returns

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

LstDocs()

Devolve uma lista de todos os documentos.

Declaration

StdBELista LstDocs()

Returns

Type	Description
StdBELista	Lista com os documentos.

LstPeriodos(String)

Devolve uma lista com todos os períodos bloqueados de um documento.

Declaration

StdBELista LstPeriodos(string Documento)

Parameters

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

Returns

Type	Description
StdBELista	Lista com os períodos.

PeriodoBloqueado(String, DateTime)

Indica se uma data se encontra num período bloqueado.

Declaration

bool PeriodoBloqueado(string Documento, DateTime Data)

Parameters

Type	Name	Description
System.String	Documento	Código do documento (Documento).
System.DateTime	Data	Data a validar.

Returns

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

Remove(String)

Remove um documento.

Declaration

void Remove(string Tipodoc)

Parameters

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

RemovePeriodo(String, DateTime, DateTime)

Remove um período bloqueado de um documento.

Declaration

void RemovePeriodo(string Documento, DateTime DataInicial, DateTime DataFinal)

Parameters

Type	Name	Description
System.String	Documento	Código do documento (Documento).
System.DateTime	DataInicial	Data inicial do período.
System.DateTime	DataFinal	Data final do período.

RemoveTodosPeriodos(String)

Remove todos os períodos bloqueados de um documento.

Declaration

void RemoveTodosPeriodos(string Documento)

Parameters

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

ValidaActualizacao(InvBETabComposicao, String)

Valida a atualização de um documento.

Declaration

bool ValidaActualizacao(InvBETabComposicao Documento, string ERRO)

Parameters

Type	Name	Description
InvBETabComposicao	Documento	Objecto identifica o documento.
System.String	ERRO	Mensagens de erro devolvidas.

Returns

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

ValidaActualizacaoPeriodo(DateTime, DateTime, ref String)

Valida a actualização do bloqueio de um período.

Declaration

bool ValidaActualizacaoPeriodo(DateTime DataInicio, DateTime DataFim, ref string ERRO)

Parameters

Type	Name	Description
System.DateTime	DataInicio	Data inicial do período.
System.DateTime	DataFim	Data final do período.
System.String	ERRO	Mensagens de erro devolvidas.

Returns

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

ValidaRemocao(String, String)

Valida a remoção de um documento.

Declaration

bool ValidaRemocao(string Tipodoc, string ERRO)

Parameters

Type	Name	Description
System.String	Tipodoc	Código do documento (Documento).
System.String	ERRO	Mensagens de erro devolvidas.

Returns

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