Interface ITTEBSPayTransacoes

Classe utilizada para obter serviços e regras de negócio sobre Transações Pagamentos Eletrónicos.

Namespace: ITTEBS100

Assembly: ITTEBS100.dll

Syntax

[ComVisible(true)]
[Guid("0598ED05-6B5E-4E51-95EF-C86880B9FAB2")]
public interface ITTEBSPayTransacoes

Methods

Actualiza(TTEBEPayTransacao)

Actualiza a Transacção Pagamentos Eletrónicos.

Declaration

void Actualiza(TTEBEPayTransacao clsTransacao)

Parameters

Type	Name	Description
TTEBEPayTransacao	clsTransacao	Objecto que identifica a Transação Pagamentos Eletrónicos.

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

Actualiza o valor de um atributo da Transacção Pagamentos Eletrónicos.

Declaration

void ActualizaValorAtributo(string strFilial, string strModulo, string strTipoDoc, string strSerieDoc, string strNumDoc, string Atributo, dynamic Valor)

Parameters

Type	Name	Description
System.String	strFilial	Identifica a Filial do Documento.
System.String	strModulo	Identifica a Módulo do Documento.
System.String	strTipoDoc	Identifica a Tipo do Documento.
System.String	strSerieDoc	Identifica a Série do Documento.
System.String	strNumDoc	Identifica a Número do Documento.
System.String	Atributo	Identifica o atributo a actualizar.
System.Object	Valor	Identifica o valor a gravar no atributo seleccionado.

ActualizaValorAtributoID(String, String, Object)

Actualiza o valor de um atributo da Transacção Pagamentos Eletrónicos.

Declaration

void ActualizaValorAtributoID(string strID, string Atributo, dynamic Valor)

Parameters

Type	Name	Description
System.String	strID	Identifica o Id da Transação Pagamentos Eletrónicos.
System.String	Atributo	Identifica o atributo a actualizar.
System.Object	Valor	Identifica o valor a gravar no atributo seleccionado.

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

Actualiza o valor de um conjunto de atributos da Transacção Pagamentos Eletrónicos.

Declaration

void ActualizaValorAtributos(string strFilial, string strModulo, string strTipoDoc, string strSerieDoc, string strNumDoc, StdBECampos Atributos)

Parameters

Type	Name	Description
System.String	strFilial	Identifica a Filial do Documento.
System.String	strModulo	Identifica a Módulo do Documento.
System.String	strTipoDoc	Identifica a Tipo do Documento.
System.String	strSerieDoc	Identifica a Série do Documento.
System.String	strNumDoc	Identifica a Número do Documento.
StdBECampos	Atributos	Identifica os atributos e os respectivos valores a actualizar.

ActualizaValorAtributosID(String, StdBECampos)

Actualiza o valor de um conjunto de atributos da Transacção Pagamentos Eletrónicos.

Declaration

void ActualizaValorAtributosID(string strID, StdBECampos Atributos)

Parameters

Type	Name	Description
System.String	strID	Identifica o Id da Transação Pagamentos Eletrónicos.
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

DaEstadoTransacao(String, String, String, String, String)

Devolve o estado da Transação Pagamentos Eletrónicos.

Declaration

TTEBEPayTransacao.TTEPayEstadoTransaccao DaEstadoTransacao(string strFilial, string strModulo, string strTipoDoc, string strSerieDoc, string strNumDoc)

Parameters

Type	Name	Description
System.String	strFilial	Identifica a Filial do Documento.
System.String	strModulo	Identifica a Módulo do Documento.
System.String	strTipoDoc	Identifica a Tipo do Documento.
System.String	strSerieDoc	Identifica a Série do Documento.
System.String	strNumDoc	Identifica a Número do Documento.

Returns

Type	Description
TTEBEPayTransacao.TTEPayEstadoTransaccao

DaRefencia(String, String, String, String, String)

Devolve a Referência da Transação Pagamentos Eletrónicos.

Declaration

TTEBEPayReferencia DaRefencia(string strFilial, string strModulo, string strTipoDoc, string strSerieDoc, string strNumDoc)

Parameters

Type	Name	Description
System.String	strFilial	Identifica a Filial do Documento.
System.String	strModulo	Identifica a Módulo do Documento.
System.String	strTipoDoc	Identifica a Tipo do Documento.
System.String	strSerieDoc	Identifica a Série do Documento.
System.String	strNumDoc	Identifica a Número do Documento.

Returns

Type	Description
TTEBEPayReferencia

DaReferencaaIDCabec(String)

Devolve a Referência da Transação Pagamentos Eletrónicos.

Declaration

TTEBEPayReferencia DaReferencaaIDCabec(string strIdCabec)

Parameters

Type	Name	Description
System.String	strIdCabec	Identifica o Id do cabeçalho do documento.

Returns

Type	Description
TTEBEPayReferencia

DaReferenciaID(String)

Devolve a Referência da Transação Pagamentos Eletrónicos.

Declaration

TTEBEPayReferencia DaReferenciaID(string strIdTrans)

Parameters

Type	Name	Description
System.String	strIdTrans	Identifica o Id da Transação Pagamentos Eletrónicos.

Returns

Type	Description
TTEBEPayReferencia

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

Devolve o valor de um atributo da Transacção Pagamentos Eletrónicos.

Declaration

dynamic DaValorAtributo(string strFilial, string strModulo, string strTipoDoc, string strSerieDoc, string strNumDoc, string Atributo)

Parameters

Type	Name	Description
System.String	strFilial	Identifica a Filial do Documento.
System.String	strModulo	Identifica a Módulo do Documento.
System.String	strTipoDoc	Identifica a Tipo do Documento.
System.String	strSerieDoc	Identifica a Série do Documento.
System.String	strNumDoc	Identifica a Número do Documento.
System.String	Atributo	Identifica o atributo para o qual se pretende devolver o valor.

Returns

Type	Description
System.Object

DaValorAtributoID(String, String)

Devolve o valor de um atributo da Transacção Pagamentos Eletrónicos.

Declaration

dynamic DaValorAtributoID(string strID, string Atributo)

Parameters

Type	Name	Description
System.String	strID	Identifica o Id da Transação Pagamentos Eletrónicos.
System.String	Atributo	Identifica o atributo para o qual se pretende devolver o valor.

Returns

Type	Description
System.Object

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

Devolve o valor de um conjunto de atributos da Transacção Pagamentos Eletrónicos.

Declaration

StdBECampos DaValorAtributos(string strFilial, string strModulo, string strTipoDoc, string strSerieDoc, string strNumDoc, params dynamic[] Atributos)

Parameters

Type	Name	Description
System.String	strFilial	Identifica a Filial do Documento.
System.String	strModulo	Identifica a Módulo do Documento.
System.String	strTipoDoc	Identifica a Tipo do Documento.
System.String	strSerieDoc	Identifica a Série do Documento.
System.String	strNumDoc	Identifica a Número do Documento.
System.Object[]	Atributos	Identifica os atributos para os quais se pretende devolver o valor.

Returns

Type	Description
StdBECampos

DaValorAtributosID(String, String[])

Devolve o valor de um conjunto de atributos da Transacção Pagamentos Eletrónicos.

Declaration

StdBECampos DaValorAtributosID(string strID, string[] Atributos)

Parameters

Type	Name	Description
System.String	strID	Identifica o Id da Transação Pagamentos Eletrónicos.
System.String[]	Atributos	Identifica os atributos para os quais se pretende devolver o valor.

Returns

Type	Description
StdBECampos

Edita(String, String, String, String, String)

Edita a Transação Pagamentos Eletrónicos.

Declaration

TTEBEPayTransacao Edita(string strFilial, string strModulo, string strTipoDoc, string strSerieDoc, string strNumDoc)

Parameters

Type	Name	Description
System.String	strFilial	Identifica a Filial do Documento.
System.String	strModulo	Identifica a Módulo do Documento.
System.String	strTipoDoc	Identifica a Tipo do Documento.
System.String	strSerieDoc	Identifica a Série do Documento.
System.String	strNumDoc	Identifica a Número do Documento.

Returns

Type	Description
TTEBEPayTransacao

EditaID(String)

Edita a Transação Pagamentos Eletrónicos.

Declaration

TTEBEPayTransacao EditaID(string strID)

Parameters

Type	Name	Description
System.String	strID	Identifica o Id da Transação Pagamentos Eletrónicos.

Returns

Type	Description
TTEBEPayTransacao

GeraReferencia(String, String, String, String, String)

Gera a referência de Pagamentos Eletrónicos.

Declaration

void GeraReferencia(string strFilial, string strModulo, string strTipoDoc, string strSerieDoc, string strNumDoc)

Parameters

Type	Name	Description
System.String	strFilial	Identifica a Filial do Documento.
System.String	strModulo	Identifica a Módulo do Documento.
System.String	strTipoDoc	Identifica a Tipo do Documento.
System.String	strSerieDoc	Identifica a Série do Documento.
System.String	strNumDoc	Identifica a Número do Documento.

GeraReferenciaID(String)

Gera a referência de Pagamentos Eletrónicos.

Declaration

void GeraReferenciaID(string strIdTrans)

Parameters

Type	Name	Description
System.String	strIdTrans	Identifica o Id da Transação Pagamentos Eletrónicos.

LiquidaDocumento(String, String, String, String, String)

Liquida o Documento da Transação Pagamentos Eletrónicos.

Declaration

bool LiquidaDocumento(string strFilial, string strModulo, string strTipoDoc, string strSerieDoc, string strNumDoc)

Parameters

Type	Name	Description
System.String	strFilial	Identifica a Filial do Documento.
System.String	strModulo	Identifica a Módulo do Documento.
System.String	strTipoDoc	Identifica a Tipo do Documento.
System.String	strSerieDoc	Identifica a Série do Documento.
System.String	strNumDoc	Identifica a Número do Documento.

Returns

Type	Description
System.Boolean

LiquidaDocumentoID(String)

Liquida o Documento da Transação Pagamentos Eletrónicos.

Declaration

bool LiquidaDocumentoID(string strID)

Parameters

Type	Name	Description
System.String	strID	Identifica o Id da Transação Pagamentos Eletrónicos.

Returns

Type	Description
System.Boolean

LstTransacoes(TTEBEPayTransacao.TTEPayEstadoTransaccao, String, String)

Lista o conjunto de Transações Pagamentos Eletrónicos.

Declaration

StdBELista LstTransacoes(TTEBEPayTransacao.TTEPayEstadoTransaccao enEstadoTransacao, string dtInicial = "", string dtFinal = "")

Parameters

Type	Name	Description
TTEBEPayTransacao.TTEPayEstadoTransaccao	enEstadoTransacao	Identifica o estado da Transação Pagamentos Eletrónicos.
System.String	dtInicial	Identifica a data inicial.
System.String	dtFinal	Identifica a data final.

Returns

Type	Description
StdBELista

RegistaTransacao(String, Object)

Efectua o registo de uma Transação Pagamentos Eletrónicos.

Declaration

string RegistaTransacao(string strModulo, dynamic objDoc)

Parameters

Type	Name	Description
System.String	strModulo	Identifica a Módulo do Documento.
System.Object	objDoc	Objecto com o conteúdo do documento associado à Transação Pagamentos Eletrónicos.

Returns

Type	Description
System.String	Devolve o identificador da Transação Pagamentos Eletrónicos criada.

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

Remove uma Transacção Pagamentos Eletrónicos.

Declaration

void Remove(string strFilial, string strModulo, string strTipoDoc, string strSerieDoc, string strNumDoc)

Parameters

Type	Name	Description
System.String	strFilial	Identifica a Filial do Documento.
System.String	strModulo	Identifica a Módulo do Documento.
System.String	strTipoDoc	Identifica a Tipo do Documento.
System.String	strSerieDoc	Identifica a Série do Documento.
System.String	strNumDoc	Identifica a Número do Documento.

RemoveID(String)

Remove uma Transacção Pagamentos Eletrónicos.

Declaration

void RemoveID(string strID)

Parameters

Type	Name	Description
System.String	strID	Identifica o Id da Transação Pagamentos Eletrónicos.

ValidaActualizacao(TTEBEPayTransacao, String)

Efectua as validações necessárias à actualização da Transacção Pagamentos Eletrónicos.

Declaration

bool ValidaActualizacao(TTEBEPayTransacao clsTransacao, string StrErro)

Parameters

Type	Name	Description
TTEBEPayTransacao	clsTransacao	Objecto que identifica a Transação Pagamentos Eletrónicos.
System.String	StrErro	Identifica eventuais erros na validação.

Returns

Type	Description
System.Boolean

ValidaRemocao(String, String, String, String, String, String)

Efectua as validações necessárias à remoção de uma Transação Pagamentos Eletrónicos.

Declaration

bool ValidaRemocao(string strFilial, string strModulo, string strTipoDoc, string strSerieDoc, string strNumDoc, string StrErro)

Parameters

Type	Name	Description
System.String	strFilial	Identifica a Filial do Documento.
System.String	strModulo	Identifica a Módulo do Documento.
System.String	strTipoDoc	Identifica a Tipo do Documento.
System.String	strSerieDoc	Identifica a Série do Documento.
System.String	strNumDoc	Identifica a Número do Documento.
System.String	StrErro	Identifica eventuais erros na validação.

Returns

Type	Description
System.Boolean

ValidaRemocaoID(String, String)

Efectua as validações necessárias à remoção de uma Transação Pagamentos Eletrónicos.

Declaration

bool ValidaRemocaoID(string strID, string StrErro)

Parameters

Type	Name	Description
System.String	strID	Identifica o Id da Transação Pagamentos Eletrónicos.
System.String	StrErro	Identifica eventuais erros na validação.

Returns

Type	Description
System.Boolean