Interface IInvBSEncargos

Classe que implementa as regras de negócio sobre encargos/descontos.

Namespace: IInvBS100

Assembly: IInvBS100.dll

Syntax

[ComVisible(true)]
[Guid("A528ABC1-13E0-477F-849F-8F25D22F862D")]
public interface IInvBSEncargos

Methods

Actualiza(String, String, InvBEEncargos, Boolean, String, String, String)

Actualiza um encargo.

Declaration

void Actualiza(string sModulo, string sDocumento, InvBEEncargos oEncargos, bool bEmModoEdicao, string sIDDocumentoOrigem, string sIDNovo, string strAvisos = "")

Parameters

Type	Name	Description
System.String	sModulo	Módulo do documento que originou o lançamento do encargo (Modulo).
System.String	sDocumento	Código do documento que está na origem do lançamento do encargo.
InvBEEncargos	oEncargos	Objeto que identifica o encargo.
System.Boolean	bEmModoEdicao	Indica se o encargo está em edição (EmModoEdicao).
System.String	sIDDocumentoOrigem	Identificador do documento que originou o lançamento, caso se trate de uma alteração (IDCabecOrigem).
System.String	sIDNovo	Identificador do novo documento que está na origem do lançamento, caso se trate de uma alteração (IDCabecOrigem).
System.String	strAvisos	Devolve os avisos encontrados durante a actualização.

Remarks

O sDocumento serve para identificar se se trata de um documento a Débito ou Crédito.

ActualizaValorAtributo(String, String, Object)

Actualiza o valor de um atributo no cabeçalho de um documento.

Declaration

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

Parameters

Type	Name	Description
System.String	sID	Identificador do encargo (ID).
System.String	Atributo	Nome do atributo.
System.Object	Valor	Valor do atributo.

ActualizaValorAtributos(String, StdBECampos)

Atualiza os valores de um conjunto de atributos de um encargo.

Declaration

void ActualizaValorAtributos(string sID, StdBECampos Atributos)

Parameters

Type	Name	Description
System.String	sID	Identificador do encargo (ID).
StdBECampos	Atributos	Coleção com os atributos e respetivos valores.

AdicionaDocumento(InvBEEncargos, String, Boolean, Int32)

Adiciona a uma coleção de encargos um documento de compras a ser utilizado na afectação.

Declaration

void AdicionaDocumento(InvBEEncargos DocEncargos, string IDDocumento, bool Distribui = false, int LinhaEncargo = -1)

Parameters

Type	Name	Description
InvBEEncargos	DocEncargos	Coleção com os encargos.
System.String	IDDocumento	Identificador do documento de compra.
System.Boolean	Distribui	Indica se é feita a distribuição automática após o documento de compra ser adicionado.
System.Int32	LinhaEncargo	Indica a linha do encargo onde o documento deve ser adicionado.

AdicionaEncargo(InvBEEncargos, String, Double)

Adiciona um novo encargo a uma colecção de encargos.

Declaration

void AdicionaEncargo(InvBEEncargos DocEncargos, string Encargo, double Valor)

Parameters

Type	Name	Description
InvBEEncargos	DocEncargos	Coleção com os encargos.
System.String	Encargo	Código do tipo de encargo (Encargo).
System.Double	Valor	Valor a distribuir para o encargo.

DaCamposUtil()

Devolve os campos de utilizador.

Declaration

StdBECampos DaCamposUtil()

Returns

Type	Description
StdBECampos	Coleção com os campos de utilizador.

DaDefCamposUtil()

Devolve as definições dos campos do utilizador.

Declaration

StdBEDefCamposUtil DaDefCamposUtil()

Returns

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

DaDefCamposUtilLinhas()

Devolve as definições dos campos do utilizador das linhas dos encargos.

Declaration

StdBEDefCamposUtil DaDefCamposUtilLinhas()

Returns

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

DaValorAtributo(String, String)

Devolve o valor de um atributo de um encargo.

Declaration

dynamic DaValorAtributo(string sID, string Atributo)

Parameters

Type	Name	Description
System.String	sID	Identificador do encargo (ID).
System.String	Atributo	Nome do atributo.

Returns

Type	Description
System.Object	Valor identificado pelo atributo.

DaValorAtributoLock(String, String)

Devolve o valor de um atributo de um encargo.

Declaration

dynamic DaValorAtributoLock(string sID, string Atributo)

Parameters

Type	Name	Description
System.String	sID	Identificador do encargo (ID).
System.String	Atributo	Nome do atributo.

Returns

Type	Description
System.Object	Valor identificado pelo atributo.

DaValorAtributos(String, String[])

Devolve um conjunto de valores de um encargo.

Declaration

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

Parameters

Type	Name	Description
System.String	sID	Identificador do encargo (ID).
System.String[]	Atributos	Array com os nomes dos atributos.

Returns

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

DaValorAtributosIDLinha(String, String[])

Devolve um conjunto de valores de uma linha de um encargo.

Declaration

StdBECampos DaValorAtributosIDLinha(string sID, params string[] Atributos)

Parameters

Type	Name	Description
System.String	sID	Identificador da linha do encargo (ID).
System.String[]	Atributos	Array com os nomes dos atributos.

Returns

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

DaValorAtributosIDLinhaLock(String, String[])

Devolve um conjunto de valores de uma linha de um encargo.

Declaration

StdBECampos DaValorAtributosIDLinhaLock(string sID, params string[] Atributos)

Parameters

Type	Name	Description
System.String	sID	Identificador da linha do encargo (ID).
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.

DaValorAtributosLock(String, String[])

Devolve um conjunto de valores de um encargo.

Declaration

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

Parameters

Type	Name	Description
System.String	sID	Identificador do encargo (ID).
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.

DistribuiEncargos(InvBEEncargos, Int32)

Com base nos encargos, valores e documentos introduzidos, efetua a distribuição dos valores de acordo com as fórmulas.

Declaration

void DistribuiEncargos(InvBEEncargos DocEncargo, int LinhaEncargo = -1)

Parameters

Type	Name	Description
InvBEEncargos	DocEncargo	Coleção com os encargos.
System.Int32	LinhaEncargo	Indica a linha do encargo a proceder à distribuição (opcional). Caso o valor seja -1 efetua a distribuição para todos os encargos.

Edita(String, String)

Edita a informação do documento de encargos

Declaration

InvBEEncargos Edita(string sModulo, string sID)

Parameters

Type	Name	Description
System.String	sModulo	Módulo do documento que está na origem do lançamento do encargo (Modulo).
System.String	sID	Identificador do documento que está na origem do lançamento do encargo (IDCabecOrigem).

Returns

Type	Description
InvBEEncargos	Objeto que representa o encargo.

Existe(String, String)

Indica se um encargo existe.

Declaration

bool Existe(string sModulo, string sID)

Parameters

Type	Name	Description
System.String	sModulo	Módulo do documento que originou o lançamento do encargo (Modulo).
System.String	sID	Identificador do encargo (ID).

Returns

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

Remove(String)

Remove um encargo.

Declaration

void Remove(string sID)

Parameters

Type	Name	Description
System.String	sID	Identificador do encargo (ID).

ValidaActualizacao(InvBEEncargo, ref String)

Valida a atualização de um encargo.

Declaration

bool ValidaActualizacao(InvBEEncargo oEncargo, ref string StrErro)

Parameters

Type	Name	Description
InvBEEncargo	oEncargo	Objeto que identifica o encargo.
System.String	StrErro

Returns

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

ValidaRemocao(InvBEEncargo, String)

Valida a remoção de um encargo.

Declaration

bool ValidaRemocao(InvBEEncargo oEncargo, string sErro)

Parameters

Type	Name	Description
InvBEEncargo	oEncargo	Objeto que identifica o encargo.
System.String	sErro	Mensagens de erro devolvidas.

Returns

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