Interface ITTEBSATTransacoes

Classe utilizada para obter serviços e regras de negócio sobre Transações de Comunicação AT.

Namespace: ITTEBS100

Assembly: ITTEBS100.dll

Syntax

[ComVisible(true)]
[Guid("B117F007-EA21-4FAF-B224-1A1C951017D3")]
public interface ITTEBSATTransacoes

Methods

Actualiza(TTEBEATTransacao)

Actualiza a Transação da Comunicação AT.

Declaration

void Actualiza(TTEBEATTransacao clsTransacao)

Parameters

Type	Name	Description
TTEBEATTransacao	clsTransacao	Objecto que identifica a Transação da Comunicação AT.

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

Actualiza o valor de um atributo da Transação de Comunicação AT.

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 Transação de Comunicação AT.

Declaration

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

Parameters

Type	Name	Description
System.String	strID	Identifica o Id da Transação.
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 Transação de Comunicação AT.

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 Transação de Comunicação AT.

Declaration

void ActualizaValorAtributosID(string strID, StdBECampos Atributos)

Parameters

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

DaEstadoNotificacao(String, String, String, String, String)

Devolvo e Estado da Última Notificacao.

Declaration

TTEBEATTransacao.TTEATEstadoNotificacao DaEstadoNotificacao(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
TTEBEATTransacao.TTEATEstadoNotificacao

DaEstadoNotificacao(String, String, String, String, String, ref String)

Devolvo e Estado da Última Notificacao.

Declaration

TTEBEATTransacao.TTEATEstadoNotificacao DaEstadoNotificacao(string strFilial, string strModulo, string strTipoDoc, string strSerieDoc, string strNumDoc, ref string strNotasNotificacao)

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	strNotasNotificacao	Identifica as notas da notificação.

Returns

Type	Description
TTEBEATTransacao.TTEATEstadoNotificacao

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

Devolve o Estado da Transacao.

Declaration

TTEBEATTransacao.TTEATEstadoTransaccao 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
TTEBEATTransacao.TTEATEstadoTransaccao

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

Devolve o valor de um atributo da Transação de Comunicação AT.

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 Transação de Comunicação AT.

Declaration

dynamic DaValorAtributoID(string strID, string Atributo)

Parameters

Type	Name	Description
System.String	strID	Identifica o Id da Transação.
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 Transação de Comunicação AT.

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, Object[])

Devolve o valor de um conjunto de atributos da Transação de Comunicação AT.

Declaration

StdBECampos DaValorAtributosID(string strID, params dynamic[] Atributos)

Parameters

Type	Name	Description
System.String	strID	Identifica o Id da Transação.
System.Object[]	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 da Comunicação AT.

Declaration

TTEBEATTransacao 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
TTEBEATTransacao

EditaID(String)

Edita a Transação da Comunicação AT.

Declaration

TTEBEATTransacao EditaID(string strID)

Parameters

Type	Name	Description
System.String	strID	Identifica o Id da Transação.

Returns

Type	Description
TTEBEATTransacao

EnviaTransacao(String, String, String, String, String)

Efectua o envio de uma Transação de Comunicação AT.

Declaration

void EnviaTransacao(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.

EnviaTransacaoID(String)

Efectua o envio de uma Transação de Comunicação AT.

Declaration

void EnviaTransacaoID(string strIdTrans)

Parameters

Type	Name	Description
System.String	strIdTrans	Identifica o Id da Transação.

LstTransacoes(TTEBEATTransacao.TTEATEstadoTransaccao, TTEBEATTransacao.TTEATEstadoNotificacao, TTEBEATTransacao.TTEATTipoDocumentoLog, String, String)

Lista o conjunto de transacções de Comunicação AT.

Declaration

StdBELista LstTransacoes(TTEBEATTransacao.TTEATEstadoTransaccao enEstadoTransacao, TTEBEATTransacao.TTEATEstadoNotificacao enEstadoNotificacao, TTEBEATTransacao.TTEATTipoDocumentoLog enTipoDocumentoLog, string dtInicial = "", string dtFinal = "")

Parameters

Type	Name	Description
TTEBEATTransacao.TTEATEstadoTransaccao	enEstadoTransacao	Identifica o estado da Transação de Comunicação AT.
TTEBEATTransacao.TTEATEstadoNotificacao	enEstadoNotificacao	Identifica o estado da Notificação da Transação de Comunicação AT.
TTEBEATTransacao.TTEATTipoDocumentoLog	enTipoDocumentoLog	Identifica o tipo de documento da Transação de Comunicação AT.
System.String	dtInicial	Identifica a data inicial.
System.String	dtFinal	Identifica a data final.

Returns

Type	Description
StdBELista

ReenviaTransacao(String, String, String, String, String)

Efectua o reenvio de uma Transação de Comunicação AT.

Declaration

void ReenviaTransacao(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.

ReenviaTransacaoID(String)

Efectua o reenvio de uma Transação de Comunicação AT.

Declaration

void ReenviaTransacaoID(string strIdTrans)

Parameters

Type	Name	Description
System.String	strIdTrans	Identifica o Id da Transação.

RegistaTransacao(String, Object)

Efectua o registo de uma Transação de Comunicação AT.

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 de Comunicação AT.

Returns

Type	Description
System.String	Devolve o identificador da Transação de Comunicação AT.

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

Remove uma Transação de Comunicação AT.

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 Transação de Comunicação AT.

Declaration

void RemoveID(string strID)

Parameters

Type	Name	Description
System.String	strID	Identifica o Id da Transação.

ValidaActualizacao(TTEBEATTransacao, String)

Efectua as validações necessárias à actualização da Transação de Comunicação AT.

Declaration

bool ValidaActualizacao(TTEBEATTransacao clsTransacao, string StrErro)

Parameters

Type	Name	Description
TTEBEATTransacao	clsTransacao	Objecto que identifica os Transacoes da aplicaçao.
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 de Comunicação AT.

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 de Comunicação AT.

Declaration

bool ValidaRemocaoID(string strID, string StrErro)

Parameters

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

Returns

Type	Description
System.Boolean