Interface IInvBSComposicoes

Classe que implementa as regras de negócio sobre os documentos de composição e decomposição.

Namespace: IInvBS100

Assembly: IInvBS100.dll

Syntax

[ComVisible(true)]
[Guid("B6EAD9A8-2B32-4E1E-8AE6-B25293FCFD5B")]
public interface IInvBSComposicoes

Methods

Actualiza(InvBEDocumentoComposicao, ref String)

Actualiza um documento.

Declaration

void Actualiza(InvBEDocumentoComposicao DocumentoComposicao, ref string strErros)

Parameters

Type	Name	Description
InvBEDocumentoComposicao	DocumentoComposicao	Objeto que identifica o documento.
System.String	strErros	Devolve os erros/avisos encontrados.

ActualizaLinhaPai(InvBEDocumentoComposicao, String, Double)

Atualiza a quantidade de uma linha pai

Declaration

void ActualizaLinhaPai(InvBEDocumentoComposicao Documento, string strIdLinhaPai, double dblQuantidade = 0)

Parameters

Type	Name	Description
InvBEDocumentoComposicao	Documento	Objeto do documento de Composição/Decomposição
System.String	strIdLinhaPai	ID da linha pai
System.Double	dblQuantidade	Quantidade a adicionar/definir na linha pai

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

Actualiza o valor de um atributo no cabeçalho de um documento.

Declaration

void ActualizaValorAtributo(string Tipodoc, int NumDoc, string Filial, string Serie, string Atributo, dynamic Valor)

Parameters

Type	Name	Description
System.String	Tipodoc	Código do tipo de documento (Tipodoc).
System.Int32	NumDoc	Número do documento (NumDoc).
System.String	Filial	Filial do documento (Filial).
System.String	Serie	Série do documento (Serie).
System.String	Atributo	Nome do atributo.
System.Object	Valor	Valor do atributo.

ActualizaValorAtributoID(String, String, Object)

Actualiza o valor de um atributo no cabeçalho deu um documento.

Declaration

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

Parameters

Type	Name	Description
System.String	Id	Identificador do cabeçalho do documento (ID).
System.String	Atributo	Nome do atributo.
System.Object	Valor	Valor do atributo.

ActualizaValorAtributos(String, Int32, String, String, StdBECampos)

Atualiza os valores de um conjunto de atributos no cabeçalho do documento.

Declaration

void ActualizaValorAtributos(string Tipodoc, int NumDoc, string Filial, string Serie, StdBECampos Atributos)

Parameters

Type	Name	Description
System.String	Tipodoc	Código do tipo de documento (Tipodoc).
System.Int32	NumDoc	Número do documento (NumDoc).
System.String	Filial	Filial do documento (Filial).
System.String	Serie	Série do documento (Serie).
StdBECampos	Atributos	Coleção com os atributos e respetivos valores.

ActualizaValorAtributosID(String, StdBECampos)

Atualiza os valores de um conjunto de atributos no cabeçalho do documento com base no identifiador.

Declaration

void ActualizaValorAtributosID(string Id, StdBECampos Atributos)

Parameters

Type	Name	Description
System.String	Id	Identificador do cabeçalho do documento (ID).
StdBECampos	Atributos	Coleção com os atributos e respetivos valores.

AdicionaComponentes(InvBEDocumentoComposicao, Int32)

Adiciona os componentes definidos na ficha técnica a uma linha de um artigo composto.

Declaration

InvBELinhasComponentes AdicionaComponentes(InvBEDocumentoComposicao Documento, int Linha)

Parameters

Type	Name	Description
InvBEDocumentoComposicao	Documento	Objeto que identifica o documento.
System.Int32	Linha	Número da linha do artigo composto.

Returns

Type	Description
InvBELinhasComponentes	Coleção com as linhas dos componentes.

AdicionaLinhaComponente(InvBEDocumentoComposicao, InvBELinhaComposto, String, Double, String, Double, Double, String, String)

Adiciona uma linha do componente à linha de composto indicada

Declaration

InvBELinhaComposto AdicionaLinhaComponente(InvBEDocumentoComposicao Documento, InvBELinhaComposto LinhaComposto, string Artigo, double Quantidade = 1, string Armazem = "", double PrecoUnitario = 0, double Desconto = 0, string Lote = "", string Localizacao = "")

Parameters

Type	Name	Description
InvBEDocumentoComposicao	Documento	Objeto que identifica o documento.
InvBELinhaComposto	LinhaComposto
System.String	Artigo	Código do artigo (Artigo).
System.Double	Quantidade
System.String	Armazem	Código do armazém (Armazem).
System.Double	PrecoUnitario
System.Double	Desconto
System.String	Lote	Código do lote (Lote).
System.String	Localizacao

Returns

Type	Description
InvBELinhaComposto

AdicionaLinhaComposto(InvBEDocumentoComposicao, String, Double, String, Double, Double, String, String)

Adiciona a linha do composto, bem como as linhas de componentes associadas

Declaration

InvBEDocumentoComposicao AdicionaLinhaComposto(InvBEDocumentoComposicao Documento, string Artigo, double Quantidade = 1, string Armazem = "", double PrecoUnitario = 0, double Desconto = 0, string Lote = "", string Localizacao = "")

Parameters

Type	Name	Description
InvBEDocumentoComposicao	Documento	Objeto que identifica o documento.
System.String	Artigo	Código do artigo (Artigo).
System.Double	Quantidade
System.String	Armazem	Código do armazém (Armazem).
System.Double	PrecoUnitario
System.Double	Desconto
System.String	Lote	Código do lote (Lote).
System.String	Localizacao	Código da localização (Localizacao).

Returns

Type	Description
InvBEDocumentoComposicao

CalculaLoteUnicoCompostos(InvBEDocumentoComposicao)

Permite partir as linhas dos artigos compostos (que tenham tratamento de lotes) pelas várias combinações possíveis de lotes dos componentes.

Declaration

void CalculaLoteUnicoCompostos(InvBEDocumentoComposicao Documento)

Parameters

Type	Name	Description
InvBEDocumentoComposicao	Documento	Objeto que identifica o documento.

DaDefCamposUtil()

Devolve as definições dos campos do utilizador do cabeçalho do documento.

Declaration

StdBEDefCamposUtil DaDefCamposUtil()

Returns

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

DaDefCamposUtilLinhas()

Devolve as definições dos campos do utilizador das linhas do documento.

Declaration

StdBEDefCamposUtil DaDefCamposUtilLinhas()

Returns

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

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

Devolve o valor de um atributo do cabeçalho de um documento.

Declaration

dynamic DaValorAtributo(string Tipodoc, int NumDoc, string Filial, string Serie, string Atributo)

Parameters

Type	Name	Description
System.String	Tipodoc	Código do tipo de documento (Tipodoc).
System.Int32	NumDoc	Número do documento (NumDoc).
System.String	Filial	Filial do documento (Filial).
System.String	Serie	Série do documento (Serie).
System.String	Atributo	Nome do atributo.

Returns

Type	Description
System.Object	Valor identificado pelo atributo.

DaValorAtributoID(String, ref String)

Devolve o valor de um atributo do cabeçalho de um documento a partir do identificador.

Declaration

dynamic DaValorAtributoID(string Id, ref string Atributo)

Parameters

Type	Name	Description
System.String	Id	Identificador do cabeçalho do documento (ID).
System.String	Atributo	Nome do atributo.

Returns

Type	Description
System.Object	Valor identificado pelo atributo.

DaValorAtributoLinhaID(String, String)

Devolve o valor de um atributo de uma linha.

Declaration

dynamic DaValorAtributoLinhaID(string Id, string Atributo)

Parameters

Type	Name	Description
System.String	Id	Identificador do cabeçalho do documento (ID).
System.String	Atributo

Returns

Type	Description
System.Object	Valor identificado pelo atributo.

DaValorAtributoLock(String, Int32, String, String, String)

Devolve o valor de um atributo do cabeçalho de um documento.

Declaration

dynamic DaValorAtributoLock(string Tipodoc, int NumDoc, string Filial, string Serie, string Atributo)

Parameters

Type	Name	Description
System.String	Tipodoc	Código do tipo de documento (Tipodoc).
System.Int32	NumDoc	Número do documento (NumDoc).
System.String	Filial	Filial do documento (Filial).
System.String	Serie	Série do documento (Serie).
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.

DaValorAtributoLockID(String, ref String)

Devolve o valor de um atributo do cabeçalho de um documento a partir do identificador.

Declaration

dynamic DaValorAtributoLockID(string Id, ref string Atributo)

Parameters

Type	Name	Description
System.String	Id	Identificador do cabeçalho do documento (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, Int32, String, String, String[])

Devolve um conjunto de valores do cabeçalho de um documento.

Declaration

StdBECampos DaValorAtributos(string Tipodoc, int NumDoc, string Filial, string Serie, params string[] Atributos)

Parameters

Type	Name	Description
System.String	Tipodoc	Código do tipo de documento (Tipodoc).
System.Int32	NumDoc	Número do documento (NumDoc).
System.String	Filial	Filial do documento (Filial).
System.String	Serie	Série do documento (Serie).
System.String[]	Atributos	Array com os nomes dos atributos.

Returns

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

DaValorAtributosID(String, String[])

Devolve um conjunto de valores do cabeçalho de um documento a partir de um identificador.

Declaration

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

Parameters

Type	Name	Description
System.String	Id	Identificador do cabeçalho do documento (ID).
System.String[]	Atributos	Array com os nomes dos atributos.

Returns

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

DaValorAtributosIDLinha(String, String[])

Devolve um conjunto de valores de uma linha de um documento.

Declaration

StdBECampos DaValorAtributosIDLinha(string sID, params string[] Atributos)

Parameters

Type	Name	Description
System.String	sID	Identificador da linha do documento (IdLinha; IdLinha).
System.String[]	Atributos	Array com os nomes dos atributos.

Returns

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

DaValorAtributosIDLinhaLock(String, String[])

Devolve um conjunto de valores de uma linha de um documento.

Declaration

StdBECampos DaValorAtributosIDLinhaLock(string sID, params string[] Atributos)

Parameters

Type	Name	Description
System.String	sID	Identificador da linha do documento (IdLinha; IdLinha).
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.

DaValorAtributosLock(String, Int32, String, String, String[])

Devolve um conjunto de valores do cabeçalho de um documento.

Declaration

StdBECampos DaValorAtributosLock(string Tipodoc, int NumDoc, string Filial, string Serie, params string[] Atributos)

Parameters

Type	Name	Description
System.String	Tipodoc	Código do tipo de documento (Tipodoc).
System.Int32	NumDoc	Número do documento (NumDoc).
System.String	Filial	Filial do documento (Filial).
System.String	Serie	Série do documento (Serie).
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.

DaValorAtributosLockID(String, String[])

Devolve um conjunto de valores do cabeçalho de um documento a partir de um identificador.

Declaration

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

Parameters

Type	Name	Description
System.String	Id	Identificador do cabeçalho do documento (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.

Edita(String, Int32, String, String)

Edita o documento de composição

Declaration

InvBEDocumentoComposicao Edita(string Tipodoc, int NumDoc, string Filial, string Serie)

Parameters

Type	Name	Description
System.String	Tipodoc	Código do tipo de documento (Tipodoc).
System.Int32	NumDoc	Número do documento (NumDoc).
System.String	Filial	Filial do documento (Filial).
System.String	Serie	Série do documento (Serie).

Returns

Type	Description
InvBEDocumentoComposicao	Objeto que representa o documento.

EditaID(String)

Edita o documento de composição

Declaration

InvBEDocumentoComposicao EditaID(string Id)

Parameters

Type	Name	Description
System.String	Id	Identificador do cabeçalho do documento (ID).

Returns

Type	Description
InvBEDocumentoComposicao	Objeto que representa o documento.

Existe(String, Int32, String, String)

Indica se um documento existe.

Declaration

bool Existe(string Tipodoc, int NumDoc, string Filial, string Serie)

Parameters

Type	Name	Description
System.String	Tipodoc	Código do tipo de documento (Tipodoc).
System.Int32	NumDoc	Número do documento (NumDoc).
System.String	Filial	Filial do documento (Filial).
System.String	Serie	Série do documento (Serie).

Returns

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

ExisteID(String)

Indica se um documento existe a partir do identificador.

Declaration

bool ExisteID(string Id)

Parameters

Type	Name	Description
System.String	Id	Identificador do cabeçalho do documento (ID).

Returns

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

ImprimeDocumento(String, Int32, String, String, Int32, String, Boolean, String)

Imprime um documento para uma impressora ou para um ficheiro no formato PDF.

Declaration

bool ImprimeDocumento(string Tipodoc, int NumDoc, string Filial, string Serie, int Numvias = 0, string NomeReport = "", bool SegundaVia = false, string DestinoPDF = "")

Parameters

Type	Name	Description
System.String	Tipodoc	Código do tipo de documento (Tipodoc).
System.Int32	NumDoc	Número do documento (NumDoc).
System.String	Filial	Filial do documento (Filial).
System.String	Serie	Série do documento (Serie).
System.Int32	Numvias	Número de vias a serem impressas.
System.String	NomeReport	Código do mapa a ser impresso (caso não seja definido, será utilizado o da definido na série).
System.Boolean	SegundaVia	Indica se é uma segunda via a ser impressa.
System.String	DestinoPDF	Define o nome do ficheiro PDF (caminho incluído) de destino. Quando indicado a impressão não é enviada para uma impressora.

Returns

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

ListaComponentes(String, String)

Devolve uma lista com as linhas dos componentes de um artigo composto num documento de composição ou decomposição.

Declaration

StdBELista ListaComponentes(string IDDoc, string IDLinhaComposto)

Parameters

Type	Name	Description
System.String	IDDoc	Identificador do cabeçalho do documento (ID).
System.String	IDLinhaComposto	Identificador da linha do artigo composto (IdLinha).

Returns

Type	Description
StdBELista

PreencheDadosRelacionados(InvBEDocumentoComposicao)

Preenche o cabeçalho de um documento com os valores sugeridos por omissão.

Declaration

InvBEDocumentoComposicao PreencheDadosRelacionados(InvBEDocumentoComposicao Documento)

Parameters

Type	Name	Description
InvBEDocumentoComposicao	Documento	Objeto que identifica o documento.

Returns

Type	Description
InvBEDocumentoComposicao	Objeto que representa o documento.

PreencheDadosRelacionados(InvBEDocumentoComposicao, ref Int32)

Preenche o cabeçalho de um documento com os valores sugeridos por omissão.

Declaration

InvBEDocumentoComposicao PreencheDadosRelacionados(InvBEDocumentoComposicao Documento, ref int Preenche)

Parameters

Type	Name	Description
InvBEDocumentoComposicao	Documento	Objeto que identifica o documento.
System.Int32	Preenche	Indica quais os valores relacionados que devem ser preenchidos segundo o enumerado BasBETiposGcp.PreencheRelacaoStk.

Returns

Type	Description
InvBEDocumentoComposicao	Objeto que representa o documento.

SugereArtigoLinhaComponente(InvBEDocumentoComposicao, String, Double, String, Double, Double, String, String, String, String)

Devolve uma ou mais linhas (artigos simples/compostos).

Declaration

InvBELinhaComponente SugereArtigoLinhaComponente(InvBEDocumentoComposicao Documento, string Artigo, double Quantidade = 1, string Armazem = "", double PrecoUnitario = 0, double Desconto = 0, string Lote = "", string Localizacao = "", string Moeda = "", string IdLinhaPai = "")

Parameters

Type	Name	Description
InvBEDocumentoComposicao	Documento	Objeto que identifica o documento.
System.String	Artigo	Código do artigo (Artigo).
System.Double	Quantidade	Quantidade do artigo.
System.String	Armazem	Código do armazém (Armazem).
System.Double	PrecoUnitario	Preço unitário do artigo.
System.Double	Desconto	Identifica o desconto.
System.String	Lote	Código do lote (Lote).
System.String	Localizacao	Código da localização (Localizacao).
System.String	Moeda	Código da moeda (Moeda).
System.String	IdLinhaPai	Identificador da linha do compoente que corresponde à linha pai caso o artigo é filho de numa dimensão (IdLinha).

Returns

Type	Description
InvBELinhaComponente

SugereArtigoLinhaComposto(InvBEDocumentoComposicao, String, Double, String, Double, Double, String, String, String, String)

Devolve uma ou mais linhas (artigos simples/compostos).

Declaration

InvBELinhaComposto SugereArtigoLinhaComposto(InvBEDocumentoComposicao Documento, string Artigo, double Quantidade = 1, string Armazem = "", double PrecoUnitario = 0, double Desconto = 0, string Lote = "", string Localizacao = "", string Moeda = "", string IdLinhaPai = "")

Parameters

Type	Name	Description
InvBEDocumentoComposicao	Documento	Objeto que identifica o documento.
System.String	Artigo	Código do artigo (Artigo).
System.Double	Quantidade	Quantidade do artigo.
System.String	Armazem	Código do armazém (Armazem).
System.Double	PrecoUnitario	Preço unitário do artigo.
System.Double	Desconto	Identifica o desconto.
System.String	Lote	Código do lote (Lote).
System.String	Localizacao	Código da localização (Localizacao).
System.String	Moeda	Código da moeda (Moeda).
System.String	IdLinhaPai	Identificador da linha do artigo composto que corresponde à linha pai caso o artigo é filho de numa dimensão (IdLinha).

Returns

Type	Description
InvBELinhaComposto

SugerePrecoUnitario(String, String, String, BasBETipos.EnumTipoCustoComponentesArtigos)

Devolve o preço unitário sugerido para artigo/armazém/lote.

Declaration

double SugerePrecoUnitario(string Artigo, string Armazem = "", string Lote = "", BasBETipos.EnumTipoCustoComponentesArtigos TipoCusto)

Parameters

Type	Name	Description
System.String	Artigo	Código do artigo (Artigo).
System.String	Armazem	Código do armazém (Armazem).
System.String	Lote	Código do lote (Lote).
BasBETipos.EnumTipoCustoComponentesArtigos	TipoCusto

Returns

Type	Description
System.Double	Valor do preço sugerido.

ValidaActualizacao(InvBEDocumentoComposicao, ref String)

Efectua as validações necessárias quando se actualiza um documento de composição.

Declaration

bool ValidaActualizacao(InvBEDocumentoComposicao Documento, ref string StrErro)

Parameters

Type	Name	Description
InvBEDocumentoComposicao	Documento	Objeto que identifica o documento.
System.String	StrErro	Devolve os erros encontrados.

Returns

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