Interface IInvBSComunicacaoInventarios

Classe que implementa as regras de negócio sobre a comunicação de inventários à AT.

Namespace: IInvBS100

Assembly: IInvBS100.dll

Syntax

[ComVisible(true)]
[Guid("15EB7652-A0C2-4384-81E2-D0B7CAFEE0CA")]
public interface IInvBSComunicacaoInventarios

Methods

Actualiza(InvBEComunicacaoInventario)

Atualiza e processa um nova comunicação de inventário.

Declaration

void Actualiza(InvBEComunicacaoInventario BEComunicacaoInventario)

Parameters

Type	Name	Description
InvBEComunicacaoInventario	BEComunicacaoInventario	Objecto que identifica a comunicação.

Actualiza(InvBEComunicacaoInventario, ref String)

Atualiza e processa um nova comunicação de inventário.

Declaration

void Actualiza(InvBEComunicacaoInventario BEComunicacaoInventario, ref string Avisos)

Parameters

Type	Name	Description
InvBEComunicacaoInventario	BEComunicacaoInventario	Objecto que identifica a comunicação.
System.String	Avisos	Avisos encontrados no processamento.

ActualizaValorAtributo(Int32, String, Object)

Actualiza o valor de um atributo.

Declaration

void ActualizaValorAtributo(int NumExportacao, string Atributo, dynamic Valor)

Parameters

Type	Name	Description
System.Int32	NumExportacao	Número da exportação (NumExportacao).
System.String	Atributo	Nome do atributo.
System.Object	Valor	Valor do atributo.

ActualizaValorAtributos(Int32, StdBECampos)

Actualiza os valores de um conjunto de atributos.

Declaration

void ActualizaValorAtributos(int NumExportacao, StdBECampos Atributos)

Parameters

Type	Name	Description
System.Int32	NumExportacao	Número da exportação (NumExportacao).
StdBECampos	Atributos	Coleção com os atributos e respetivos valores.

DaDataPeriodo(Int32)

Devolve a data do período correspondente a um determinado exercício.

Declaration

DateTime DaDataPeriodo(int Exercicio)

Parameters

Type	Name	Description
System.Int32	Exercicio	Exercício de origem para o cálculo da data.

Returns

Type	Description
System.DateTime	Data do período.

DaDefCamposUtil()

Devolve as definições dos campos do utilizador.

Declaration

StdBEDefCamposUtil DaDefCamposUtil()

Returns

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

DaDescricaoOmissao(Int32, DateTime)

Devolve a descrição por omissão para uma comunicação.

Declaration

string DaDescricaoOmissao(int Exercicio, DateTime DataPeriodo)

Parameters

Type	Name	Description
System.Int32	Exercicio	Exercício da comunicação.
System.DateTime	DataPeriodo	Data de período da comunicação.

Returns

Type	Description
System.String	Descrição por omissão.

DaValorAtributo(Int32, String)

Devolve o valor de um atributo da comunicação.

Declaration

dynamic DaValorAtributo(int NumExportacao, string Atributo)

Parameters

Type	Name	Description
System.Int32	NumExportacao	Número da exportação (NumExportacao).
System.String	Atributo	Nome do atributo.

Returns

Type	Description
System.Object	Valor identificado pelo atributo.

DaValorAtributos(Int32, String[])

Devolve o valor de um conjunto de atributos.

Declaration

StdBECampos DaValorAtributos(int NumExportacao, params string[] Atributos)

Parameters

Type	Name	Description
System.Int32	NumExportacao	Número da exportação (NumExportacao).
System.String[]	Atributos	Array com os nomes dos atributos.

Returns

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

Edita(Int32)

Edita uma comunicação.

Declaration

InvBEComunicacaoInventario Edita(int NumExportacao)

Parameters

Type	Name	Description
System.Int32	NumExportacao	Número da exportação (NumExportacao).

Returns

Type	Description
InvBEComunicacaoInventario	Objecto que representa a comunicação.

EditaLinhas(Int32, String)

Devolve uma lista com as linhas de uma comunicação.

Declaration

StdBELista EditaLinhas(int NumExportacao, string CamposSelect = "")

Parameters

Type	Name	Description
System.Int32	NumExportacao	Número da exportação (NumExportacao).
System.String	CamposSelect	Lista de campos a usar no SELECT da instrução SQL.

Returns

Type	Description
StdBELista	Linhas da comunicação.

EditaLinhasDt(Int32, String)

Devolve uma lista com as linhas de uma comunicação.

Declaration

DataTable EditaLinhasDt(int NumExportacao, string CamposSelect = "")

Parameters

Type	Name	Description
System.Int32	NumExportacao	Número da exportação (NumExportacao).
System.String	CamposSelect	Lista de campos a usar no SELECT da instrução SQL.

Returns

Type	Description
System.Data.DataTable	Linhas da comunicação.

Existe(Int32)

Indica se uma comunicação existe.

Declaration

bool Existe(int NumExportacao)

Parameters

Type	Name	Description
System.Int32	NumExportacao	Número da exportação (NumExportacao).

Returns

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

GeraFicheiro(InvBEComunicacaoInventario, String)

Gera o ficheiro XML correspondente à comunicação.

Declaration

bool GeraFicheiro(InvBEComunicacaoInventario BEComunicacaoInventario, string Avisos = "")

Parameters

Type	Name	Description
InvBEComunicacaoInventario	BEComunicacaoInventario	Objecto que identifica a comunicação.
System.String	Avisos	Devolve os avisos encontrados na geração do ficheiro.

Returns

Type	Description
System.Boolean	True - Sucesso na geração; False - Sem sucesso na geração

Remove(Int32)

Anula uma determinada exportação.

Declaration

void Remove(int NumExportacao)

Parameters

Type	Name	Description
System.Int32	NumExportacao	Número da exportação (NumExportacao).