Interface IInvBSConfiguracaoEstados

Classe que implementa as regras de negócio sobre a configuração de estados de inventário nos documentos.

Namespace: IInvBS100

Assembly: IInvBS100.dll

Syntax

[ComVisible(true)]
[Guid("B0081E4B-0077-4FB5-AF92-A48F2727B158")]
public interface IInvBSConfiguracaoEstados

Methods

Actualiza(InvBEConfigEstados)

Actualiza uma configuração de estados.

Declaration

void Actualiza(InvBEConfigEstados ConfigEstados)

Parameters

Type	Name	Description
InvBEConfigEstados	ConfigEstados	Objeto que identifica a configuração de estados.

ActualizaEx(InvBEConfigEstados, Object)

Actualiza uma configuração de estados.

Declaration

void ActualizaEx(InvBEConfigEstados ConfigEstados, dynamic Documento)

Parameters

Type	Name	Description
InvBEConfigEstados	ConfigEstados	Objeto que identifica a configuração de estados.
System.Object	Documento	Objecto que identifica o documento original.

ActualizaValorAtributo(String, String, String, Object)

Actualiza o valor de um atributo.

Declaration

void ActualizaValorAtributo(string IdTipoOrigem, string Documento, string Atributo, dynamic Valor)

Parameters

Type	Name	Description
System.String	IdTipoOrigem	Identificador do tipo de origem dos documentos que correspondente ao módulo e aplicação integradora (Id).
System.String	Documento	Código do documento da aplicação integradora.
System.String	Atributo	Nome do atributo.
System.Object	Valor	Valor do atributo.

ActualizaValorAtributos(String, String, StdBECampos)

Actualiza os valores de um conjunto de atributos.

Declaration

void ActualizaValorAtributos(string IdTipoOrigem, string Documento, StdBECampos Atributos)

Parameters

Type	Name	Description
System.String	IdTipoOrigem	Identificador do tipo de origem dos documentos que correspondente ao módulo e aplicação integradora (Id).
System.String	Documento	Código do documento da aplicação integradora.
StdBECampos	Atributos	Coleção com os atributos e respetivos valores.

DaCamposUtil()

Devolve os campos de utilizador.

Declaration

StdBECampos DaCamposUtil()

Returns

Type	Description
StdBECampos	Coleção com os campos de utilizador.

DaDefCamposUtil()

Devolve as definições dos campos do utilizador.

Declaration

StdBEDefCamposUtil DaDefCamposUtil()

Returns

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

DaValorAtributo(String, String, String)

Devolve o valor de um atributo.

Declaration

dynamic DaValorAtributo(string IdTipoOrigem, string Documento, string Atributo)

Parameters

Type	Name	Description
System.String	IdTipoOrigem	Identificador do tipo de origem dos documentos que correspondente ao módulo e aplicação integradora (Id).
System.String	Documento	Código do documento da aplicação integradora.
System.String	Atributo	Nome do atributo.

Returns

Type	Description
System.Object	Valor identificado pelo atributo.

DaValorAtributoLock(String, String, String)

Devolve o valor de um atributo.

Declaration

dynamic DaValorAtributoLock(string IdTipoOrigem, string Documento, string Atributo)

Parameters

Type	Name	Description
System.String	IdTipoOrigem	Identificador do tipo de origem dos documentos que correspondente ao módulo e aplicação integradora (Id).
System.String	Documento	Código do documento da aplicação integradora.
System.String	Atributo	Nome do atributo.

Returns

Type	Description
System.Object	Valor identificado pelo atributo.

Remarks

O sufixo "Lock" indica que os valores serão obtidos a partir da cache de sistema.

DaValorAtributos(String, String, String[])

Devolve o valor de um conjunto de atributos da configuração de estados.

Declaration

StdBECampos DaValorAtributos(string IdTipoOrigem, string Documento, params string[] Atributos)

Parameters

Type	Name	Description
System.String	IdTipoOrigem	Identificador do tipo de origem dos documentos que correspondente ao módulo e aplicação integradora (Id).
System.String	Documento	Código do documento da aplicação integradora.
System.String[]	Atributos	Array com os nomes dos atributos.

Returns

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

DaValorAtributosLock(String, String, String[])

Devolve o valor de um conjunto de atributos de uma configuração de estados.

Declaration

StdBECampos DaValorAtributosLock(string IdTipoOrigem, string Documento, params string[] Atributos)

Parameters

Type	Name	Description
System.String	IdTipoOrigem	Identificador do tipo de origem dos documentos que correspondente ao módulo e aplicação integradora (Id).
System.String	Documento	Código do documento da aplicação integradora.
System.String[]	Atributos	Array com os nomes dos atributos.

Returns

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

Remarks

O sufixo "Lock" indica que os valores serão obtidos a partir da cache de sistema.

DevolveEstadoDefeito(String, String, InvBETipos.EnumTipoConfigEstados, ref String, ref String)

Devolve o estado de inventário por omissão para um documento e tipo de movimento.

Declaration

void DevolveEstadoDefeito(string IdTipoOrigem, string Documento, InvBETipos.EnumTipoConfigEstados TipoMov, ref string EstadoOrigem, ref string EstadoDestino)

Parameters

Type	Name	Description
System.String	IdTipoOrigem	Identificador do tipo de origem dos documentos que correspondente ao módulo e aplicação integradora (Id).
System.String	Documento	Código do documento da aplicação integradora.
InvBETipos.EnumTipoConfigEstados	TipoMov	Indica se o movimento é referente a linhas positivas ou negativas.
System.String	EstadoOrigem	Devolve o código do estado origem por omissão (Estado).
System.String	EstadoDestino	Devolve o código do estado destino por omissão (Estado).

DevolveWhereFiltroEstados(String, String, InvBETipos.EnumTipoConfigEstados, InvBETipos.EnumEstadoOrigemDestino)

Devolve uma instrução WHERE de SQL para aplicação de um filtro.

Declaration

string DevolveWhereFiltroEstados(string IdTipoOrigem, string Documento, InvBETipos.EnumTipoConfigEstados TipoMov, InvBETipos.EnumEstadoOrigemDestino OrigemDestino)

Parameters

Type	Name	Description
System.String	IdTipoOrigem	Identificador do tipo de origem dos documentos que correspondente ao módulo e aplicação integradora (Id).
System.String	Documento	Código do documento da aplicação integradora.
InvBETipos.EnumTipoConfigEstados	TipoMov	Indica se o movimento é referente a linhas positivas ou negativas.
InvBETipos.EnumEstadoOrigemDestino	OrigemDestino	Indica se é um estado origem ou destino.

Returns

Type	Description
System.String	Instrução WHERE de SQL.

Examples

WHERE Estado IS NULL; WHERE Estado IN (...)

Edita(String, String)

Edita uma configuração de estados.

Declaration

InvBEConfigEstados Edita(string IdTipoOrigem, string Documento)

Parameters

Type	Name	Description
System.String	IdTipoOrigem	Identificador do tipo de origem dos documentos que correspondente ao módulo e aplicação integradora (Id).
System.String	Documento	Código do documento da aplicação integradora.

Returns

Type	Description
InvBEConfigEstados	Objecto que representa a configuração de estados.

Existe(String, String)

indica se uma configuração de estados existe.

Declaration

bool Existe(string IdTipoOrigem, string Documento)

Parameters

Type	Name	Description
System.String	IdTipoOrigem	Identificador do tipo de origem dos documentos que correspondente ao módulo e aplicação integradora (Id).
System.String	Documento	Código do documento da aplicação integradora.

Returns

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

ExisteEstado(String, String, InvBETipos.EnumTipoConfigEstados, InvBETipos.EnumEstadoOrigemDestino, String)

Indica se uma configuração de estados de inventário existe.

Declaration

bool ExisteEstado(string IdTipoOrigem, string Documento, InvBETipos.EnumTipoConfigEstados TipoMov, InvBETipos.EnumEstadoOrigemDestino OrigemDestino, string Estado)

Parameters

Type	Name	Description
System.String	IdTipoOrigem	Identificador do tipo de origem dos documentos que correspondente ao módulo e aplicação integradora (Id).
System.String	Documento	Código do documento da aplicação integradora.
InvBETipos.EnumTipoConfigEstados	TipoMov	Indica se o movimento é referente a linhas positivas ou negativas.
InvBETipos.EnumEstadoOrigemDestino	OrigemDestino	Indica se é um estado origem ou destino.
System.String	Estado	Código do estado de inventário (Estado).

Returns

Type	Description
System.Boolean

ExisteLinha(String, String, String, String)

indica se uma linha de uma configuração de estados existe.

Declaration

bool ExisteLinha(string IdTipoOrigem, string Documento, string EstadoOrigem, string EstadoDestino)

Parameters

Type	Name	Description
System.String	IdTipoOrigem	Identificador do tipo de origem dos documentos que correspondente ao módulo e aplicação integradora (Id).
System.String	Documento	Código do documento da aplicação integradora.
System.String	EstadoOrigem	Código do estado origem (Estado).
System.String	EstadoDestino	Código do estado destino (Estado).

Returns

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

LstEstados(String, String)

Devolve uma lista com todas as configurações de estados.

Declaration

StdBELista LstEstados(string IdTipoOrigem = "", string Documento = "")

Parameters

Type	Name	Description
System.String	IdTipoOrigem	Identificador do tipo de origem dos documentos que correspondente ao módulo e aplicação integradora (Id).
System.String	Documento	Código do documento da aplicação integradora.

Returns

Type	Description
StdBELista	Lista com as configurações de estados.

Remove(String, String)

Remove uma configuração de estados.

Declaration

void Remove(string IdTipoOrigem, string Documento)

Parameters

Type	Name	Description
System.String	IdTipoOrigem	Identificador do tipo de origem dos documentos que correspondente ao módulo e aplicação integradora (Id).
System.String	Documento	Código do documento da aplicação integradora.

RemoveLinha(String, String, String, String)

Remove uma linha de uma configuração de estados.

Declaration

void RemoveLinha(string IdTipoOrigem, string Documento, string EstadoOrigem, string EstadoDestino)

Parameters

Type	Name	Description
System.String	IdTipoOrigem	Identificador do tipo de origem dos documentos que correspondente ao módulo e aplicação integradora (Id).
System.String	Documento	Código do documento da aplicação integradora.
System.String	EstadoOrigem	Código do estado origem (Estado).
System.String	EstadoDestino	Código do estado destino (Estado).

ValidaActualizacao(InvBEConfigEstados, ref String)

Valida a actualização de uma configuração de estados.

Declaration

bool ValidaActualizacao(InvBEConfigEstados ConfigEstados, ref string StrErro)

Parameters

Type	Name	Description
InvBEConfigEstados	ConfigEstados	Objeto que identifica a configuração de estados.
System.String	StrErro	Mensagens de erro devolvidas.

Returns

Type	Description
System.Boolean	True - Validação com sucesso; False - Validação sem sucesso

ValidaRemocao(String, String, String)

Valida a remoção de uma configuração de estados.

Declaration

bool ValidaRemocao(string IdTipoOrigem, string Documento, string StrErro)

Parameters

Type	Name	Description
System.String	IdTipoOrigem	Identificador do tipo de origem dos documentos que correspondente ao módulo e aplicação integradora (Id).
System.String	Documento	Código do documento da aplicação integradora.
System.String	StrErro	Mensagens de erro devolvidas.

Returns

Type	Description
System.Boolean

ValidaRemocaoLinha(String, String, String, String, String)

Valida a remoção de uma linha de uma configuração de estados.

Declaration

bool ValidaRemocaoLinha(string IdTipoOrigem, string Documento, string EstadoOrigem, string EstadoDestino, string StrErro)

Parameters

Type	Name	Description
System.String	IdTipoOrigem	Identificador do tipo de origem dos documentos que correspondente ao módulo e aplicação integradora (Id).
System.String	Documento	Código do documento da aplicação integradora.
System.String	EstadoOrigem	Código do estado origem (Estado).
System.String	EstadoDestino	Código do estado destino (Estado).
System.String	StrErro	Mensagens de erro devolvidas.

Returns

Type	Description
System.Boolean	True - Validação com sucesso; False - Validação sem sucesso