Interface IInvBSTransfArtigo

Classe que implementa as regras de negócio sobre os documentos de transferência de artigos.

Namespace: IInvBS100

Assembly: IInvBS100.dll

Syntax

[ComVisible(true)]
[Guid("71BF4C20-BC32-4280-9D0E-A146F34666A7")]
public interface IInvBSTransfArtigo

Methods

Actualiza(InvBEDocumentoTransfArtigo, ref String)

Actualiza um documento.

Declaration

void Actualiza(InvBEDocumentoTransfArtigo Documento, ref string strErros)

Parameters

Type	Name	Description
InvBEDocumentoTransfArtigo	Documento	Objeto que identifica o documento.
System.String	strErros	Mensagens de erro devolvidas.

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

Actualiza o valor de um atributo do 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 do cabeçalho de 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 de um cabeçalho de um 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 de um cabeçalho de um documento.

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.

DaDefCamposUtil()

Devolve as definições dos campos do utilizador do cabeçalho das transferências.

Declaration

StdBEDefCamposUtil DaDefCamposUtil()

Returns

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

DaDefCamposUtilLinhas()

Devolve as definições dos campos do utilizador das linhas das transferências.

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.

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 de de um documento.

Declaration

dynamic DaValorAtributoLinhaID(string Id, string Atributo)

Parameters

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

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.

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).
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).
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.

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 um documento.

Declaration

InvBEDocumentoTransfArtigo 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
InvBEDocumentoTransfArtigo	Objeto que representa o documento.

EditaID(String)

Edita um documento.

Declaration

InvBEDocumentoTransfArtigo EditaID(string Id)

Parameters

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

Returns

Type	Description
InvBEDocumentoTransfArtigo	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.

Declaration

bool ExisteID(string Id)

Parameters

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

Returns

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

ExisteTransferenciaArtigoAposData(String, DateTime)

Indica se existe alguma transferência de um artigo após uma determinada data.

Declaration

bool ExisteTransferenciaArtigoAposData(string Artigo, DateTime DataPesquisa)

Parameters

Type	Name	Description
System.String	Artigo	Código do artigo (Artigo).
System.DateTime	DataPesquisa	Data a partir da qual a validação é efetuada.

Returns

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

ExisteTransferenciaArtigoAposData(String, DateTime, ref String)

Indica se existe alguma transferência de um artigo após uma determinada data.

Declaration

bool ExisteTransferenciaArtigoAposData(string Artigo, DateTime DataPesquisa, ref string CodigoTransferencia)

Parameters

Type	Name	Description
System.String	Artigo	Código do artigo (Artigo).
System.DateTime	DataPesquisa	Permite definir uma data mínima para a pesquisa dos registos.
System.String	CodigoTransferencia	Devolve o código da primeira transferência encontrada.

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

PreencheDadosRelacionados(InvBEDocumentoTransfArtigo)

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

Declaration

InvBEDocumentoTransfArtigo PreencheDadosRelacionados(InvBEDocumentoTransfArtigo Documento)

Parameters

Type	Name	Description
InvBEDocumentoTransfArtigo	Documento	Objecto que identifica o documento.

Returns

Type	Description
InvBEDocumentoTransfArtigo	Objecto que representa o documento.

PreencheDadosRelacionados(InvBEDocumentoTransfArtigo, ref Int32)

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

Declaration

InvBEDocumentoTransfArtigo PreencheDadosRelacionados(InvBEDocumentoTransfArtigo Documento, ref int Preenche)

Parameters

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

Returns

Type	Description
InvBEDocumentoTransfArtigo	Objecto que representa o documento.

PreencheLinhasTransferenciaArtigo(InvBEDocumentoTransfArtigo)

Preenche as linhas de um documento com os movimentos de stock a transferir.

Declaration

void PreencheLinhasTransferenciaArtigo(InvBEDocumentoTransfArtigo Documento)

Parameters

Type	Name	Description
InvBEDocumentoTransfArtigo	Documento	Objeto que identifica o documento.

TransfereArtigoFichaTecnica(String, String)

Tranfere a ficha técnica de um artigo para outro.

Declaration

void TransfereArtigoFichaTecnica(string ArtigoOrigem, string ArtigoDestino)

Parameters

Type	Name	Description
System.String	ArtigoOrigem	Código do artigo de origem (ArtigoOrigem).
System.String	ArtigoDestino	Código do artigo de destino (ArtigoDestino).

ValidaActualizacao(InvBEDocumentoTransfArtigo, InvBETabTransferencia, ref String)

Valida a atualização de um documento.

Declaration

bool ValidaActualizacao(InvBEDocumentoTransfArtigo Documento, InvBETabTransferencia Tipodoc, ref string StrErro)

Parameters

Type	Name	Description
InvBEDocumentoTransfArtigo	Documento	Objeto que identifica o documento.
InvBETabTransferencia	Tipodoc	Objeto que identifica o tipo de documento da transferência.
System.String	StrErro	Mensagens de erro devolvidas.

Returns

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

VerificaArtigoUsadoFichaTecnica(String)

Indica se um artigo é usado em alguma ficha técnica.

Declaration

bool VerificaArtigoUsadoFichaTecnica(string ArtigoOrigem)

Parameters

Type	Name	Description
System.String	ArtigoOrigem	Código do artigo (ArtigoOrigem).

Returns

Type	Description
System.Boolean	True - Usado; False - Não usado