Interface ICctBSDescontos

Esta classe deve ser usada para efectuar descontos de títulos.

Namespace: ICctBS100

Assembly: ICctBS100.dll

Syntax

[ComVisible(true)]
[Guid("3DC75696-41E0-4ECC-842D-1065D073FE54")]
public interface ICctBSDescontos

Methods

Actualiza(CctBEDocumentoDesconto, String)

Permite efectuar a actualização de um desconto.

Declaration

void Actualiza(CctBEDocumentoDesconto DocDesconto, string StrAviso = "")

Parameters

Type	Name	Description
CctBEDocumentoDesconto	DocDesconto	Objecto que identifica o desconto a gravar.
System.String	StrAviso

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

Permite efectuar a actualização de um atributo do desconto.

Declaration

void ActualizaValorAtributo(string TipoDoc, int NumDoc, string Filial, string Serie, string Atributo, dynamic Valor)

Parameters

Type	Name	Description
System.String	TipoDoc	Código do tipo de documento a liquidar.
System.Int32	NumDoc	Número do documento a liquidar.
System.String	Filial	Código da filial do documento a liquidar.
System.String	Serie
System.String	Atributo	Identifica o atributo a actualizar.
System.Object	Valor	Identifica o valor a atribuir ao atributo.

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

Permite efectuar a actualização de um conjunto de atributos do desconto.

Declaration

void ActualizaValorAtributos(string TipoDoc, int NumDoc, string Filial, string Serie, StdBECampos Atributos)

Parameters

Type	Name	Description
System.String	TipoDoc	Código do tipo de documento a liquidar.
System.Int32	NumDoc	Número do documento a liquidar.
System.String	Filial	Código da filial do documento a liquidar.
System.String	Serie
StdBECampos	Atributos	Identifica os atributos e respectivos valores a actualizar.

AdicionaLinha(CctBEDocumentoDesconto, String, String, String, String, Int32, Double)

Adiciona a(s) linha(s) ao documento de liquidação com os dados do documento a liquidar.

Declaration

CctBEDocumentoDesconto AdicionaLinha(CctBEDocumentoDesconto clsDocDesconto, string Filial, string Modulo, string TipoDoc, string strSerie, int NumDoc, double ValorRecMLiq)

Parameters

Type	Name	Description
CctBEDocumentoDesconto	clsDocDesconto	Objecto que identifica o documento de liquidação a ser actualizado com os respectivos dados do artigo.
System.String	Filial	Código da filial do documento a liquidar.
System.String	Modulo	Módulo do documento a liquidar.
System.String	TipoDoc	Código do tipo de documento a liquidar.
System.String	strSerie	Série do documento a liquidar.
System.Int32	NumDoc	Número do documento a liquidar.
System.Double	ValorRecMLiq	Valor a liquidar do documento.

Returns

Type	Description
CctBEDocumentoDesconto

DaDefCamposUtil()

Devolve as definições dos campos do utilizador.

Declaration

StdBEDefCamposUtil DaDefCamposUtil()

Returns

Type	Description
StdBEDefCamposUtil

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

Devolve o valor de um determinado atributo.

Declaration

dynamic DaValorAtributo(string TipoDoc, int NumDoc, string Filial, string Serie, string Atributo)

Parameters

Type	Name	Description
System.String	TipoDoc	Código do tipo de documento a liquidar.
System.Int32	NumDoc	Número do documento a liquidar.
System.String	Filial	Código da filial do documento a liquidar.
System.String	Serie	Série do documento a liquidar.
System.String	Atributo	Identifica o atributo a devolver o valor.

Returns

Type	Description
System.Object

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

Devolve o valor de um determinado atributo.

Declaration

dynamic DaValorAtributoLock(string TipoDoc, int NumDoc, string Filial, string Serie, string Atributo)

Parameters

Type	Name	Description
System.String	TipoDoc	Código do tipo de documento a liquidar.
System.Int32	NumDoc	Número do documento a liquidar.
System.String	Filial	Código da filial do documento a liquidar.
System.String	Serie	Série do documento a liquidar.
System.String	Atributo	Identifica o atributo a devolver o valor.

Returns

Type	Description
System.Object

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

Devolve o valor de um determinado conjunto de atributos.

Declaration

StdBECampos DaValorAtributos(string TipoDoc, int NumDoc, string Filial, string Serie, params string[] Atributos)

Parameters

Type	Name	Description
System.String	TipoDoc	Código do tipo de documento a liquidar.
System.Int32	NumDoc	Número do documento a liquidar.
System.String	Filial	Código da filial do documento a liquidar.
System.String	Serie	Série do documento a liquidar.
System.String[]	Atributos	Identifica os atributos a devolver o valor.

Returns

Type	Description
StdBECampos

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

Devolve o valor de um determinado conjunto de atributos.

Declaration

StdBECampos DaValorAtributosLock(string TipoDoc, int NumDoc, string Filial, string Serie, params string[] Atributos)

Parameters

Type	Name	Description
System.String	TipoDoc	Código do tipo de documento a liquidar.
System.Int32	NumDoc	Número do documento a liquidar.
System.String	Filial	Código da filial do documento a liquidar.
System.String	Serie	Série do documento a liquidar.
System.String[]	Atributos	Identifica os atributos a devolver o valor.

Returns

Type	Description
StdBECampos

Edita(String, String, String, Int32)

Permite efectuar a edição de um desconto.

Declaration

CctBEDocumentoDesconto Edita(string Filial, string TipoDoc, string strSerie, int NumDoc)

Parameters

Type	Name	Description
System.String	Filial	Identifica a filial.
System.String	TipoDoc	Identifica o tipo de documento a considerar.
System.String	strSerie	Identifica a série a considerar.
System.Int32	NumDoc	Identifica o numero de documento a considerar.

Returns

Type	Description
CctBEDocumentoDesconto

Existe(String, String, String, Int32)

Permite verificar se um desconto existe.

Declaration

bool Existe(string Filial, string TipoDoc, string strSerie, int NumDoc)

Parameters

Type	Name	Description
System.String	Filial	Identifica a filial.
System.String	TipoDoc	Identifica o tipo de documento a considerar.
System.String	strSerie	Identifica a série a considerar.
System.Int32	NumDoc	Identifica o numero de documento a considerar.

Returns

Type	Description
System.Boolean

Remove(String, String, String, Int32, String)

Permite efectuar a remoção de um desconto.

Declaration

bool Remove(string Filial, string TipoDoc, string strSerie, int NumDoc, string StrAviso = "")

Parameters

Type	Name	Description
System.String	Filial	Identifica a filial.
System.String	TipoDoc	Identifica o tipo de documento a considerar.
System.String	strSerie	Identifica a série a considerar.
System.Int32	NumDoc	Identifica o numero de documento a considerar.
System.String	StrAviso	Devolve os erros detectados, caso existam.

Returns

Type	Description
System.Boolean

ValidaActualizacao(CctBEDocumentoDesconto, ref String)

Função que valida a possibilidade de haver transferencias

Declaration

bool ValidaActualizacao(CctBEDocumentoDesconto clsDocDesconto, ref string StrErro)

Parameters

Type	Name	Description
CctBEDocumentoDesconto	clsDocDesconto	Objecto do desconto para validação.
System.String	StrErro

Returns

Type	Description
System.Boolean

ValidaRemocao(CctBEDocumentoDesconto, ref String)

Efectua as validações necessárias para permitir remover o desconto.

Declaration

bool ValidaRemocao(CctBEDocumentoDesconto clsDocDesconto, ref string StrErro)

Parameters

Type	Name	Description
CctBEDocumentoDesconto	clsDocDesconto	Objecto do desconto a anular.
System.String	StrErro

Returns

Type	Description
System.Boolean