Interface IInvBSReservas

Classe que implementa as regras de negócio sobre as reservas de inventário.

Namespace: IInvBS100

Assembly: IInvBS100.dll

Syntax

[ComVisible(true)]
[Guid("CA8907BD-4AAD-4C7A-BFC6-6C9A6CACADAA")]
public interface IInvBSReservas

Methods

Actualiza(InvBEReserva)

Atualiza uma reserva.

Declaration

void Actualiza(InvBEReserva Reservas)

Parameters

Type	Name	Description
InvBEReserva	Reservas	Coleção com as reservas.

ActualizaValorAtributo(String, String, Object)

Actualiza o valor de um atributo da configuração de Reservas.

Declaration

void ActualizaValorAtributo(string Id, string Atributo, dynamic Valor)

Parameters

Type	Name	Description
System.String	Id	Identificador da reserva (ID).
System.String	Atributo	Nome do atributo.
System.Object	Valor	Valor do atributo.

ActualizaValorAtributos(String, StdBECampos)

Atualiza os valores de um conjunto de atributos.

Declaration

void ActualizaValorAtributos(string Id, StdBECampos Atributos)

Parameters

Type	Name	Description
System.String	Id	Identificador da reserva (ID).
StdBECampos	Atributos	Coleção com os atributos e respetivos valores.

AnulaDestino(String, String, Boolean)

Remove todas as reservas associadas a um destino sem remover os respetivos movimentos de stock.

Declaration

void AnulaDestino(string IdTipoOrigemDestino, string IdChaveDestino, bool IncluirFechadas = false)

Parameters

Type	Name	Description
System.String	IdTipoOrigemDestino	Identificador do tipo de origem do destino da reserva (IdTipoOrigemDestino).
System.String	IdChaveDestino	Identificador da linha de destino da reserva (IdChaveDestino).
System.Boolean	IncluirFechadas	Indica se serão removidas, também, as reservas fechadas (Fechada).

AnulaID(String, Boolean)

Remove uma reserva sem remover os respetivos movimentos de stock.

Declaration

void AnulaID(string Id, bool DisparaEvento = true)

Parameters

Type	Name	Description
System.String	Id	Identificador da reserva (ID).
System.Boolean	DisparaEvento	indica se o evento DepoisDeAnular será despoletado.

AnulaOrigem(String, String, Boolean)

Remove todas as reservas associadas a uma origem sem remover os respetivos movimentos de stock.

Declaration

void AnulaOrigem(string IdTipoOrigemOrigem, string IdChaveOrigem, bool IncluirFechadas = false)

Parameters

Type	Name	Description
System.String	IdTipoOrigemOrigem	Identificador do tipo de origem da origem da reserva (IdTipoOrigemOrigem).
System.String	IdChaveOrigem	Identificador da linha de origem da reserva (IdChaveOrigem).
System.Boolean	IncluirFechadas	Indica se serão removidas, também, as reservas fechadas (Fechada).

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.

DaEstadoReservaSistema(String)

Devolve o código do estado de inventário de destino numa reserva.

Declaration

string DaEstadoReservaSistema(string IdChaveDestino)

Parameters

Type	Name	Description
System.String	IdChaveDestino	Identificador da linha de destino da reserva (IdChaveDestino).

Returns

Type	Description
System.String	Código do estado de inventário (EstadoDestino).

DaMovimentosIdReserva(String)

Devolve uma coleção com as origens e os movimentos associadas a uma reserva.

Declaration

InvBEOrigens DaMovimentosIdReserva(string IdReserva)

Parameters

Type	Name	Description
System.String	IdReserva	Iden

Returns

Type	Description
InvBEOrigens	Coleção com as origens.

DaOrigensIdReserva(String)

Devolve uma coleção com as origens associadas a uma reserva.

Declaration

InvBEOrigens DaOrigensIdReserva(string IdReserva)

Parameters

Type	Name	Description
System.String	IdReserva	Identificador da reserva (ID).

Returns

Type	Description
InvBEOrigens	Coleção com as origens.

DaQuantidadesPendentes(String, String, String)

Devolve uma lista com as quantidades pendentes.

Declaration

StdBELista DaQuantidadesPendentes(string Id = "", string IdChaveOrigem = "", string IdChaveDestino = "")

Parameters

Type	Name	Description
System.String	Id	Identificador da reserva (ID).
System.String	IdChaveOrigem	Identificador da linha de origem da reserva (IdChaveOrigem).
System.String	IdChaveDestino	Identificador da linha de destino da reserva (IdChaveDestino).

Returns

Type	Description
StdBELista	Lista com as quantidades pendentes.

DaQuantReservasSatisfeitas(InvBEReserva)

Devolve a quantidade satisfeita das linhas da reserva.

Declaration

double DaQuantReservasSatisfeitas(InvBEReserva Reserva)

Parameters

Type	Name	Description
InvBEReserva	Reserva	Coleção com as reservas.

Returns

Type	Description
System.Double	Quantidade satisfeita.

Remarks

O calculo corresponde à soma da quantidade satisfeita de todas as linhas da reserva (Quantidade - QuantidadePendente).

DaValorAtributo(String, String)

Devolve o valor de um atributo.

Declaration

dynamic DaValorAtributo(string Id, string Atributo)

Parameters

Type	Name	Description
System.String	Id	Identificador da reserva (ID).
System.String	Atributo	Nome do atributo.

Returns

Type	Description
System.Object	Valor identificado pelo atributo.

DaValorAtributoLock(String, String)

Devolve o valor de um atributo.

Declaration

dynamic DaValorAtributoLock(string Id, string Atributo)

Parameters

Type	Name	Description
System.String	Id	Identificador da reserva (ID).
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[])

Devolve um conjunto de valores.

Declaration

StdBECampos DaValorAtributos(string Id, params string[] Atributos)

Parameters

Type	Name	Description
System.String	Id	Identificador da reserva (ID).
System.String[]	Atributos	Array com os nomes dos atributos.

Returns

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

DaValorAtributosLock(String, String[])

Devolve um conjunto de valores.

Declaration

StdBECampos DaValorAtributosLock(string Id, params string[] Atributos)

Parameters

Type	Name	Description
System.String	Id	Identificador da reserva (ID).
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.

EditaDestino(String, String, Boolean)

Edita as reservas de um destino.

Declaration

InvBEReserva EditaDestino(string IdTipoOrigemDestino, string IdChaveDestino, bool ReservaOriginal = false)

Parameters

Type	Name	Description
System.String	IdTipoOrigemDestino	Identificador do tipo de origem do destino da reserva (IdTipoOrigemDestino).
System.String	IdChaveDestino	Identificador da linha de destino da reserva (IdChaveDestino).
System.Boolean	ReservaOriginal	Indica se serão incluídas, também, as reservas fechadas (Fechada).

Returns

Type	Description
InvBEReserva	Coleção com as reservas.

EditaID(String, Boolean)

Edita uma reserva.

Declaration

InvBEReserva EditaID(string Id, bool IncluirFechadas = false)

Parameters

Type	Name	Description
System.String	Id	Identificador da reserva (ID).
System.Boolean	IncluirFechadas	Indica se serão editadas, também, as reservas fechadas (Fechada).

Returns

Type	Description
InvBEReserva	Coleção com as reservas.

EditaOrigem(String, String, Boolean)

Edita as reservas de uma origem.

Declaration

InvBEReserva EditaOrigem(string IdTipoOrigemOrigem, string IdChaveOrigem, bool ReservaOriginal = false)

Parameters

Type	Name	Description
System.String	IdTipoOrigemOrigem	Identificador do tipo de origem da origem da reserva (IdTipoOrigemOrigem).
System.String	IdChaveOrigem	Identificador da linha de origem da reserva (IdChaveOrigem).
System.Boolean	ReservaOriginal	Indica se serão incluídas, também, as reservas fechadas (Fechada).

Returns

Type	Description
InvBEReserva	Coleção com as reservas.

EditaOrigemDestino(String, String, String, String, String, Boolean)

Edita as reservas pelos parâmetros indicados: identificador da reserva, associadas a uma origem ou a um destino.

Declaration

InvBEReserva EditaOrigemDestino(string Id = "", string IdTipoOrigemOrigem = "", string IdChaveOrigem = "", string IdTipoOrigemDestino = "", string IdChaveDestino = "", bool ReservaOriginal = false)

Parameters

Type	Name	Description
System.String	Id	Identificador da reserva (ID).
System.String	IdTipoOrigemOrigem	Identificador do tipo de origem da origem da reserva (IdTipoOrigemOrigem).
System.String	IdChaveOrigem	Identificador da linha de origem da reserva (IdChaveOrigem).
System.String	IdTipoOrigemDestino	Identificador do tipo de origem do destino da reserva (IdTipoOrigemDestino).
System.String	IdChaveDestino	Identificador da linha de destino da reserva (IdChaveDestino).
System.Boolean	ReservaOriginal	Indica se serão incluídas, também, as reservas fechadas (Fechada).

Returns

Type	Description
InvBEReserva	Coleção com as reservas.

ExisteDestino(String, String)

Indica se existem reservas para um destino.

Declaration

bool ExisteDestino(string IdTipoOrigemDestino, string IdChaveDestino)

Parameters

Type	Name	Description
System.String	IdTipoOrigemDestino	Identificador do tipo de origem do destino da reserva (IdTipoOrigemDestino).
System.String	IdChaveDestino	Identificador da linha de destino da reserva (IdChaveDestino).

Returns

Type	Description
System.Boolean	True - Existem; False - Não existem

ExisteID(String)

Indica se uma reserva existe.

Declaration

bool ExisteID(string Id)

Parameters

Type	Name	Description
System.String	Id	Identificador da reserva (ID).

Returns

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

ExisteOrigem(String, String)

Indica se existem reservas para uma origem.

Declaration

bool ExisteOrigem(string IdTipoOrigemOrigem, string IdChaveOrigem)

Parameters

Type	Name	Description
System.String	IdTipoOrigemOrigem	Identificador do tipo de origem da origem da reserva (IdTipoOrigemOrigem).
System.String	IdChaveOrigem	Identificador da linha de origem da reserva (IdChaveOrigem).

Returns

Type	Description
System.Boolean	True - Existem; False - Não existem

LstReservas(String, String, String, String, String, Boolean)

Devolve uma lista de reservas pelos parâmetros indicados: identificador da reserva, associadas a uma origem ou a um destino.

Declaration

StdBELista LstReservas(string Id = "", string IdTipoOrigemOrigem = "", string IdChaveOrigem = "", string IdTipoOrigemDestino = "", string IdChaveDestino = "", bool ReservaOriginal = false)

Parameters

Type	Name	Description
System.String	Id	Identificador da reserva (ID).
System.String	IdTipoOrigemOrigem	Identificador do tipo de origem da origem da reserva (IdTipoOrigemOrigem).
System.String	IdChaveOrigem	Identificador da linha de origem da reserva (IdChaveOrigem).
System.String	IdTipoOrigemDestino	Identificador do tipo de origem do destino da reserva (IdTipoOrigemDestino).
System.String	IdChaveDestino	Identificador da linha de destino da reserva (IdChaveDestino).
System.Boolean	ReservaOriginal	Indica se serão incluídas, também, as reservas fechadas (Fechada).

Returns

Type	Description
StdBELista	Lista com as reservas.

PreencheOrigensReducaoReserva(InvBEOrigens, String, String, Double)

Efetua a redução de reservas.

Declaration

void PreencheOrigensReducaoReserva(InvBEOrigens Origens, string IdReserva, string IdReservaOriginal, double Quantidade)

Parameters

Type	Name	Description
InvBEOrigens	Origens	Coleção com as origens atuais que será devolvido com as novas.
System.String	IdReserva	Identificador da reserva (ID).
System.String	IdReservaOriginal	Identificador da reserva original (IdReservaOriginal)
System.Double	Quantidade	Quantidade a reduzir.

PreencheOrigensReducaoReserva(InvBEOrigens, String, String, Double, String)

Efetua a redução de reservas.

Declaration

void PreencheOrigensReducaoReserva(InvBEOrigens Origens, string IdReserva, string IdReservaOriginal, double Quantidade, string IdLinha = "")

Parameters

Type	Name	Description
InvBEOrigens	Origens	Coleção com as origens atuais que será devolvido com as novas.
System.String	IdReserva	Identificador da reserva (ID).
System.String	IdReservaOriginal	Identificador da reserva original (IdReservaOriginal)
System.Double	Quantidade	Quantidade a reduzir.
System.String	IdLinha	Identificador da linha de origem a aplicar a redução (opcional).

PreencheOrigensReducaoReserva(InvBEOrigens, String, String, Double, String, Boolean)

Efetua a redução de reservas.

Declaration

void PreencheOrigensReducaoReserva(InvBEOrigens Origens, string IdReserva, string IdReservaOriginal, double Quantidade, string IdLinha = "", bool AnulacaoReserva = false)

Parameters

Type	Name	Description
InvBEOrigens	Origens	Coleção com as origens atuais que será devolvido com as novas.
System.String	IdReserva	Identificador da reserva (ID).
System.String	IdReservaOriginal	Identificador da reserva original (IdReservaOriginal)
System.Double	Quantidade	Quantidade a reduzir.
System.String	IdLinha	Identificador da linha de origem a aplicar a redução (opcional).
System.Boolean	AnulacaoReserva	Indica se provém de uma anulação de reserva (opcional).

RemoveDestino(String, String, Boolean)

Remove todas as reservas associadas a um destino e respetivos movimentos de stock.

Declaration

void RemoveDestino(string IdTipoOrigemDestino, string IdChaveDestino, bool IncluirFechadas = false)

Parameters

Type	Name	Description
System.String	IdTipoOrigemDestino	Identificador do tipo de origem do destino da reserva (IdTipoOrigemDestino).
System.String	IdChaveDestino	Identificador da linha de destino da reserva (IdChaveDestino).
System.Boolean	IncluirFechadas	Indica se serão removidas, também, as reservas fechadas (Fechada).

RemoveDestino(String, String, Boolean, Boolean, InvBEOrigens)

Remove todas as reservas associadas a um destino e respetivos movimentos de stock.

Declaration

void RemoveDestino(string IdTipoOrigemDestino, string IdChaveDestino, bool IncluirFechadas = false, bool GravaOrigensEmLote = false, InvBEOrigens Origens = null)

Parameters

Type	Name	Description
System.String	IdTipoOrigemDestino	Identificador do tipo de origem do destino da reserva (IdTipoOrigemDestino).
System.String	IdChaveDestino	Identificador da linha de destino da reserva (IdChaveDestino).
System.Boolean	IncluirFechadas	Indica se serão removidas, também, as reservas fechadas (Fechada).
System.Boolean	GravaOrigensEmLote	Indica se a atualização das origens é efetuada no momento ou se as devolve para posterior atualização.
InvBEOrigens	Origens	Coleção a devolver com as origens.

RemoveID(String)

Remove uma reserva.

Declaration

void RemoveID(string Id)

Parameters

Type	Name	Description
System.String	Id	Identificador da reserva (ID).

RemoveID(String, Boolean, InvBEOrigens)

Remove uma reserva.

Declaration

void RemoveID(string Id, bool GravaOrigensEmLote = false, InvBEOrigens Origens = null)

Parameters

Type	Name	Description
System.String	Id	Identificador da reserva (ID).
System.Boolean	GravaOrigensEmLote	Indica se a remoção das origens é efetuada no momento ou se as devolve para posterior remoção.
InvBEOrigens	Origens	Coleção a devolver com as origens.

RemoveOrigem(String, String, Boolean, Boolean)

Remove todas as reservas associadas a uma origem e respetivos movimentos de stock.

Declaration

void RemoveOrigem(string IdTipoOrigemOrigem, string IdChaveOrigem, bool IncluirFechadas = false, bool DisparaEvento = true)

Parameters

Type	Name	Description
System.String	IdTipoOrigemOrigem	Identificador do tipo de origem da origem da reserva (IdTipoOrigemOrigem).
System.String	IdChaveOrigem	Identificador da linha de origem da reserva (IdChaveOrigem).
System.Boolean	IncluirFechadas
System.Boolean	DisparaEvento

SugereReservasAutomaticas(String, Double, String, String, String, String, InvBELinhasReserva, String, String, String, String)

Devolve uma coleção de reservas tendo em conta as disponibilidades de stock.

Declaration

InvBEReserva SugereReservasAutomaticas(string Artigo, double Quantidade, string IdTipoOrigemDestino, string IdChaveDestino, string DescricaoDestino, string EstadoDestino, InvBELinhasReserva ReservasPendentes, string Armazem = "", string Localizacao = "", string Lote = "", string IdDocReserva = "")

Parameters

Type	Name	Description
System.String	Artigo	Código do artigo a reservar (Artigo).
System.Double	Quantidade	Quantidade a reservar (Quantidade).
System.String	IdTipoOrigemDestino	Identificador do tipo de origem do destino da reserva (IdTipoOrigemDestino).
System.String	IdChaveDestino	Identificador da linha de destino da reserva (IdChaveDestino).
System.String	DescricaoDestino	Descrição do destinatário da reserva (DescricaoDestino).
System.String	EstadoDestino	Código do estado de reserva no destino (EstadoDestino).
InvBELinhasReserva	ReservasPendentes	Colecção com as linhas de reservas pendentes que ainda não estão materializadas mas devem ser contabilizadas.
System.String	Armazem	Código do armazém de origem da reserva (ArmazemOrigem).
System.String	Localizacao	Código da localização de armazém de origem da reserva (LocalizacaoOrigem).
System.String	Lote	Código do lote a reservar (Lote).
System.String	IdDocReserva	Identificador do documento de origem cujas reservas devem ser excluídas.

Returns

Type	Description
InvBEReserva	Coleção com as reservas sugeridas.

ValidaActualizacao(InvBEReserva, ref String)

Valida a atualização de uma reserva.

Declaration

bool ValidaActualizacao(InvBEReserva Reservas, ref string StrErro)

Parameters

Type	Name	Description
InvBEReserva	Reservas	Coleção com as reservas.
System.String	StrErro	Mensagens de erro devolvidas.

Returns

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

ValidaRemocaoDestino(String, String, ref String)

Valida a remoção das reservas de um destino.

Declaration

bool ValidaRemocaoDestino(string IdTipoOrigemDestino, string IdChaveDestino, ref string StrErro)

Parameters

Type	Name	Description
System.String	IdTipoOrigemDestino	Identificador do tipo de origem do destino da reserva (IdTipoOrigemDestino).
System.String	IdChaveDestino	Identificador da linha de destino da reserva (IdChaveDestino).
System.String	StrErro	Mensagens de erro devolvidas.

Returns

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

ValidaRemocaoID(String, ref String, InvBEReserva)

Valida a remoção de uma reserva.

Declaration

bool ValidaRemocaoID(string Id, ref string StrErro, InvBEReserva Reserva = null)

Parameters

Type	Name	Description
System.String	Id	Identificador da reserva (ID).
System.String	StrErro	Mensagens de erro devolvidas.
InvBEReserva	Reserva	Objeto que, quando indicado, identifica a reserva a remover.

Returns

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

ValidaRemocaoOrigem(String, String, ref String, Boolean)

Valida a remoção das reservas de uma origem.

Declaration

bool ValidaRemocaoOrigem(string IdTipoOrigemOrigem, string IdChaveOrigem, ref string StrErro, bool IncluirFechadas = false)

Parameters

Type	Name	Description
System.String	IdTipoOrigemOrigem	Identificador do tipo de origem da origem da reserva (IdTipoOrigemOrigem).
System.String	IdChaveOrigem	Identificador da linha de origem da reserva (IdChaveOrigem).
System.String	StrErro	Mensagens de erro devolvidas.
System.Boolean	IncluirFechadas

Returns

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

Events

DepoisDeActualizar

Declaration

event ActualizaReservaEventHandler DepoisDeActualizar

Event Type

Type	Description
ActualizaReservaEventHandler

DepoisDeAnular

Declaration

event AnulaReservaEventHandler DepoisDeAnular

Event Type

Type	Description
AnulaReservaEventHandler