Interface IBasBSCommunicationsManager

Defines the Communication Manager public interface.

Namespace: IBasBS100

Assembly: IBasBS100.dll

Syntax

public interface IBasBSCommunicationsManager

Methods

CarregaParametrosAdministrador(Object)

Devolve o formulário de parametrizações no administrador.

Declaration

dynamic CarregaParametrosAdministrador(dynamic Form)

Parameters

Type	Name	Description
System.Object	Form

Returns

Type	Description
System.Object

CarregaParametrosEntidadeEx(Object, Object)

Devolve o formulário de parametrizações da entidade.

Declaration

dynamic CarregaParametrosEntidadeEx(dynamic Form, dynamic Frame)

Parameters

Type	Name	Description
System.Object	Form	Objecto com o formulário.
System.Object	Frame	Objecto com a frame do formulário.

Returns

Type	Description
System.Object

DaAnexoTransacao(String, Int32)

Devolve o Anexo da Transacao.

Declaration

byte[] DaAnexoTransacao(string strIdTrans, int intTipoAnexo)

Parameters

Type	Name	Description
System.String	strIdTrans	Identifica o ID da Transacção.
System.Int32	intTipoAnexo	Identifica o tipo de anexo.

Returns

Type	Description
System.Byte[]

DaLicencas()

Devolve as licencas do user controls das dlls

Declaration

StdBEValoresStr DaLicencas()

Returns

Type	Description
StdBEValoresStr

DaParametrosEntidade(String, String)

Devolve os parametros da entidade

Declaration

dynamic DaParametrosEntidade(string strTipoEntidade, string strEntidade)

Parameters

Type	Name	Description
System.String	strTipoEntidade	Identificador do tipo de entidade
System.String	strEntidade	Identificador da entidade

Returns

Type	Description
System.Object

DocTrataTans(String, Int32, String, String, String, String)

Marca se os documentos são para ser tratados como transação electronica

Declaration

bool DocTrataTans(string Modulo, int TipoDocumento, string TipoDoc, string TipoEntidade, string Entidade, string IdDocB2B)

Parameters

Type	Name	Description
System.String	Modulo	Identificador do Modulo
System.Int32	TipoDocumento	Identificador do TipoDocumento
System.String	TipoDoc	Identificador do TipoDoc
System.String	TipoEntidade	Identificador do TipoEntidade
System.String	Entidade	Identificador da Entidade
System.String	IdDocB2B	Identificador do DocB2B a transacionar

Returns

Type	Description
System.Boolean

DocTrataTansEx(String, Int32, String, String, String, String, String, DateTime, String)

Marca se os documentos são para ser tratados como transação electronica

Declaration

bool DocTrataTansEx(string Modulo, int TipoDocumento, string TipoDoc, string TipoEntidade, string Entidade, string IdDocB2B, string Serie, DateTime DataDoc, string TipoOperacao)

Parameters

Type	Name	Description
System.String	Modulo	Identificador do Modulo
System.Int32	TipoDocumento	Identificador do TipoDocumento
System.String	TipoDoc	Identificador do TipoDoc
System.String	TipoEntidade	Identificador do TipoEntidade
System.String	Entidade	Identificador da Entidade
System.String	IdDocB2B	Identificador do DocB2B a transacionar
System.String	Serie	Identificador da Serie
System.DateTime	DataDoc	Identificador da Data do Documento
System.String	TipoOperacao	Identificador do Tipo de Operacao

Returns

Type	Description
System.Boolean

EnviaNotificacao(String)

Efectua o envio de uma notificação.

Declaration

void EnviaNotificacao(string strIdNotificacao)

Parameters

Type	Name	Description
System.String	strIdNotificacao	Identifica o ID da Notificação.

EnviaTransaccao(String)

Efectua o envio de uma transacção electrónica.

Declaration

void EnviaTransaccao(string strIdTrans)

Parameters

Type	Name	Description
System.String	strIdTrans	Identifica o ID da Transacção.

GravaParametrosEntidade(Object)

Grava os parametros da entidade

Declaration

bool GravaParametrosEntidade(dynamic objParametrosEntidade)

Parameters

Type	Name	Description
System.Object	objParametrosEntidade	Objecto que identifica os parametros da entidade

Returns

Type	Description
System.Boolean

Inicializa(Object, Object)

Inicializa o motor

Declaration

void Inicializa(dynamic plataforma, dynamic erpBS)

Parameters

Type	Name	Description
System.Object	plataforma
System.Object	erpBS

InicializaMotorComunicacao(String)

Inicializa o componente associado as comunicacoes, criando uma instância do objecto responsável pelas operações dependentes da comunicacao.

Declaration

void InicializaMotorComunicacao(string strComunicacao)

Parameters

Type	Name	Description
System.String	strComunicacao	Identifica o Id do Comunicacao.

RecebeMensagens(ref String, ref Int32, ref Int32)

Efectua a recepção de todas as mensagens disponíveis no servidor, registando respectivas transacções electrónicas e notificações.

Declaration

bool RecebeMensagens(ref string strErros, ref int intTotalMensagens, ref int intMsgsLevantadas)

Parameters

Type	Name	Description
System.String	strErros	Identifica eventuais erros na receção.
System.Int32	intTotalMensagens	Identifica o total de mensagens disponíveis para recepção.
System.Int32	intMsgsLevantadas	Identifica o total de mensagens levantadas com sucesso.

Returns

Type	Description
System.Boolean

ReenviaTransacao(String)

Reenvia a Transacao.

Declaration

string ReenviaTransacao(string strIdTrans)

Parameters

Type	Name	Description
System.String	strIdTrans	Identifica o ID da Transacção.

Returns

Type	Description
System.String

RegistaTransaccao(String, Object)

Efectua o registo de uma transacção electrónica.

Declaration

string RegistaTransaccao(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 à transacção electrónica.

Returns

Type	Description
System.String	Devolve o identificador da transacção electrónica criada.

RegistaTransaccao(String, Object, ref String)

Efectua o registo de uma transacção electrónica.

Declaration

string RegistaTransaccao(string strModulo, dynamic objDoc, ref string strCaminhoPDF)

Parameters

Type	Name	Description
System.String	strModulo	Identifica a Módulo do Documento.
System.Object	objDoc	Objecto com o conteúdo do documento associado à transacção electrónica.
System.String	strCaminhoPDF	Identifica o caminho do PDF para associar à transacção electrónica.

Returns

Type	Description
System.String	Devolve o identificador da transacção electrónica criada.

TrataTransacao(Object, String, String)

Verifica se o documento irá ser tratado pelas TTE.

Declaration

bool TrataTransacao(dynamic objDoc, string strMotorComunicacao, string strModulo)

Parameters

Type	Name	Description
System.Object	objDoc	Documento.
System.String	strMotorComunicacao	Motor de comunicacao.
System.String	strModulo

Returns

Type	Description
System.Boolean

ValidaRegistaTransaccao(String, Object)

Valida o registo de uma transacção electrónica.

Declaration

bool ValidaRegistaTransaccao(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 à transacção electrónica.

Returns

Type	Description
System.Boolean