PRIMAVERA | Developers

    Show / Hide Table of Contents

    Interface IInvBSArtigosArmazensStocks

    Classe que implementa as regras de negócio sobre as parametrizações de stocks de artigos nos armazéns.

    Namespace: IInvBS100
    Assembly: IInvBS100.dll
    Syntax
    [ComVisible(true)]
    [Guid("36B28CBF-BDC5-4384-9475-C7DD0C95B42E")]
    public interface IInvBSArtigosArmazensStocks

    Methods

    Actualiza(ref InvBEArtigoArmazemStock)

    Actualiza uma parametrização.

    Declaration
    void Actualiza(ref InvBEArtigoArmazemStock objBE)
    Parameters
    Type Name Description
    InvBEArtigoArmazemStock objBE

    Objeto que identifica a parametrização.

    ActualizaFiltroArmazens(InvBEArtigosArmazensStocks)

    Atualiza as parametrizações da coleção que correspondam ao armazém do primeiro elemento.

    Declaration
    void ActualizaFiltroArmazens(InvBEArtigosArmazensStocks objBeColl)
    Parameters
    Type Name Description
    InvBEArtigosArmazensStocks objBeColl

    Coleção com as parametrizações.

    ActualizaFiltroArtigo(InvBEArtigosArmazensStocks)

    Atualiza as parametrizações da coleção que correspondam ao artigo do primeiro elemento.

    Declaration
    void ActualizaFiltroArtigo(InvBEArtigosArmazensStocks objBeColl)
    Parameters
    Type Name Description
    InvBEArtigosArmazensStocks objBeColl

    Coleção com as parametrizações.

    ActualizaValorAtributo(String, String, String, Object)

    Actualiza o valor de um atributo.

    Declaration
    void ActualizaValorAtributo(string strArtigo, string strArmazem, string strAtributo, dynamic varValor)
    Parameters
    Type Name Description
    System.String strArtigo

    Código do artigo (Artigo).

    System.String strArmazem

    Código do armazém (Armazem).

    System.String strAtributo

    Nome do atributo.

    System.Object varValor

    Valor do atributo.

    ActualizaValorAtributos(String, String, StdBECampos)

    Actualiza os valores de um conjunto de atributos.

    Declaration
    void ActualizaValorAtributos(string strArtigo, string strArmazem, StdBECampos Atributos)
    Parameters
    Type Name Description
    System.String strArtigo

    Código do artigo (Artigo).

    System.String strArmazem

    Código do armazém (Armazem).

    StdBECampos Atributos

    Coleção com os atributos e respetivos valores.

    Compara(InvBEArtigoArmazemStock, InvBEArtigoArmazemStock)

    Compara duas parametrizações.

    Devolve o resultado da comparação segundo os seguintes critérios:

    md_NaoAlterado - As parametrizações são iguais.

    md_Inserido - A parametrização de referência é nula.

    md_Modificado - Pelo menos uma das propriedades da parametrização é diferente.

    md_Apagado - A parametrização é nula.

    Declaration
    BasBETiposGcp.enuModosAlteracaoObjectos Compara(InvBEArtigoArmazemStock objBE, InvBEArtigoArmazemStock objBEorg)
    Parameters
    Type Name Description
    InvBEArtigoArmazemStock objBE

    Objeto que identifica a parametrização a analisar.

    InvBEArtigoArmazemStock objBEorg

    Objeto que identifica a parametrização de referência na análise.

    Returns
    Type Description
    BasBETiposGcp.enuModosAlteracaoObjectos

    Resultado da análise.

    Remarks

    O resultado da comparação também é atribuído à propriedade ModoAlteracao do objeto que identifica a parametrização a analisar.

    ComparaListas(InvBEArtigosArmazensStocks, InvBEArtigosArmazensStocks)

    Compara duas coleções com parametrizações no sentido de detetar alterações.

    Devolve o resultado da comparação segundo os seguintes critérios:

    md_NaoAlterado - As coleções são iguais.

    md_Modificado - Pelo menos uma parametrização na coleção em análise é diferente.

    Declaration
    BasBETiposGcp.enuModosAlteracaoObjectos ComparaListas(InvBEArtigosArmazensStocks objBeColl, InvBEArtigosArmazensStocks objBeCollOrg)
    Parameters
    Type Name Description
    InvBEArtigosArmazensStocks objBeColl

    Coleção com as parametrizações a analisar.

    InvBEArtigosArmazensStocks objBeCollOrg

    Coleção com as parametrizações de referência.

    Returns
    Type Description
    BasBETiposGcp.enuModosAlteracaoObjectos

    Resultado da análise.

    Remarks

    O resultado da comparação também é atribuído à propriedade ModoAlteracao da coleção a analisar.

    A comparação entre as pararametrizações também provoca a atribuição à propriedade ModoAlteracao do resultado segundo os seguintes critérios:

    md_Inserido - Parametrização existe na coleção em análise sem existir na de referência.

    md_Apagado - Parametrização não existe na coleção em análise sendo recolocada.

    DaDefCamposUtil()

    Devolve as definições dos campos do Utilizador.

    Declaration
    StdBEDefCamposUtil DaDefCamposUtil()
    Returns
    Type Description
    StdBEDefCamposUtil

    Coleção com as definições.

    DaPosicaoChave(String, String, InvBEArtigosArmazensStocks)

    Devolve a posição dentro da coleção da paremetrização referente ao artigo/armazém indicado.

    Declaration
    int DaPosicaoChave(string strArtigo, string strArmazem, InvBEArtigosArmazensStocks objBeColl)
    Parameters
    Type Name Description
    System.String strArtigo

    Código do artigo (Artigo).

    System.String strArmazem

    Código do armazém.

    InvBEArtigosArmazensStocks objBeColl

    Coleçao com as parametrizações.

    Returns
    Type Description
    System.Int32

    Índice na coleção ou -1, caso não exista.

    DaValorAtributo(String, String, String)

    Devolve o valor de um atributo.

    Declaration
    dynamic DaValorAtributo(string strArtigo, string strArmazem, string strAtributo)
    Parameters
    Type Name Description
    System.String strArtigo

    Código do artigo (Artigo).

    System.String strArmazem

    Código do armazém (Armazem).

    System.String strAtributo
    Returns
    Type Description
    System.Object

    Valor identificado pelo atributo.

    DaValorAtributoLock(String, String, String)

    Devolve o valor de um atributo.

    Declaration
    dynamic DaValorAtributoLock(string strArtigo, string strArmazem, string strAtributo)
    Parameters
    Type Name Description
    System.String strArtigo

    Código do artigo (Artigo).

    System.String strArmazem

    Código do armazém.

    System.String strAtributo

    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 um conjunto de valores.

    Declaration
    StdBECampos DaValorAtributos(string strArtigo, string strArmazem, params string[] Atributos)
    Parameters
    Type Name Description
    System.String strArtigo

    Código do artigo (Artigo).

    System.String strArmazem

    Código do armazém (Armazem).

    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 um conjunto de valores.

    Declaration
    StdBECampos DaValorAtributosLock(string strArtigo, string strArmazem, params string[] Atributos)
    Parameters
    Type Name Description
    System.String strArtigo

    Código do artigo (Artigo).

    System.String strArmazem

    Código do armazém.

    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.

    DaValorChave(InvBEArtigoArmazemStock)

    Declaration
    string DaValorChave(InvBEArtigoArmazemStock objBE)
    Parameters
    Type Name Description
    InvBEArtigoArmazemStock objBE
    Returns
    Type Description
    System.String

    Edita(String, String)

    Edita uma parametrização.

    Declaration
    InvBEArtigoArmazemStock Edita(string strArtigo, string strArmazem)
    Parameters
    Type Name Description
    System.String strArtigo

    Código do artigo (Artigo).

    System.String strArmazem

    Código do armazém (Armazem).

    Returns
    Type Description
    InvBEArtigoArmazemStock

    Objeto que representa a parametrização.

    ExisteFiltroArmazens(String, InvBEArtigosArmazensStocks)

    Verifica se existe na coleção indicada, pelo menos, uma parametrização para o armazém indicado.

    Caso não seja indicada uma coleção a pesquisa é efetuada diretamente da base de dados.

    Declaration
    bool ExisteFiltroArmazens(string strArmazem, InvBEArtigosArmazensStocks objBeCollOrg = null)
    Parameters
    Type Name Description
    System.String strArmazem

    Código do armazém (Armazem).

    InvBEArtigosArmazensStocks objBeCollOrg

    Coleção com as parametrizações (opcional).

    Returns
    Type Description
    System.Boolean

    True - Existe; False - Não existe

    ExisteFiltroArtigo(String, InvBEArtigosArmazensStocks)

    Verifica se existe na coleção indicada, pelo menos, uma parametrização para o artigo indicado.

    Caso não seja indicada uma coleção a pesquisa é efetuada diretamente da base de dados.

    Declaration
    bool ExisteFiltroArtigo(string strArtigo, InvBEArtigosArmazensStocks objBeCollOrg = null)
    Parameters
    Type Name Description
    System.String strArtigo

    Código do artigo (Artigo).

    InvBEArtigosArmazensStocks objBeCollOrg

    Coleção com as parametrizações (opcional).

    Returns
    Type Description
    System.Boolean

    True - Existe; False - Não existe

    ExisteRegistosDependentes(String, String)

    Verifica se há objectos/tabelas dependentes (em Child Tables).

    Declaration
    bool ExisteRegistosDependentes(string strArtigo, string strArmazem)
    Parameters
    Type Name Description
    System.String strArtigo

    Código do artigo (Artigo).

    System.String strArmazem

    Código do armazém (Armazem).

    Returns
    Type Description
    System.Boolean

    ListaFiltroArmazens(String, InvBEArtigosArmazensStocks, Boolean)

    Devolve uma coleção de parametrizações filtrada pelo armazém indicado a partir da coleção inidicada.

    Caso não seja indicada uma coleção o resultado é obtido diretamente da base de dados.

    Declaration
    InvBEArtigosArmazensStocks ListaFiltroArmazens(string strArmazem, InvBEArtigosArmazensStocks objBeCollOrg = null, bool blnLerLinhas = false)
    Parameters
    Type Name Description
    System.String strArmazem

    Código do armazém (Armazem).

    InvBEArtigosArmazensStocks objBeCollOrg

    Coleção com as parametrizações (opcional).

    System.Boolean blnLerLinhas

    Obsoleto.

    Returns
    Type Description
    InvBEArtigosArmazensStocks

    Coleçao com as parametrizações filtradas.

    ListaFiltroArtigo(String, InvBEArtigosArmazensStocks, Boolean)

    Devolve uma coleção de parametrizações filtrada pelo artigo indicado a partir da coleção inidicada.

    Caso não seja indicada uma coleção o resultado é obtido diretamente da base de dados.

    Declaration
    InvBEArtigosArmazensStocks ListaFiltroArtigo(string strArtigo, InvBEArtigosArmazensStocks objBeCollOrg = null, bool blnLerLinhas = false)
    Parameters
    Type Name Description
    System.String strArtigo

    Código do artigo (Artigo).

    InvBEArtigosArmazensStocks objBeCollOrg

    Coleção com as parametrizações (opcional).

    System.Boolean blnLerLinhas

    Obsoleto.

    Returns
    Type Description
    InvBEArtigosArmazensStocks

    Coleçao com as parametrizações filtradas.

    ManipularListas(BasBETiposGcp.enuOperacoesListasObjectos, InvBEArtigosArmazensStocks, InvBEArtigosArmazensStocks, Boolean)

    Permite manipular duas coleções com parametrizações segundo a operaçao indicada.

    op_Copiar:

    Devolve uma uma cópia da primeira coleção.

    op_Adicionar:

    Devolve uma coleção com todas as parametrizações da primeira e da segunda coleção.

    Caso uma parametrização exista na segunda coleção devolve a parametrização tendo em conta o parâmetro blnPrioridade1.

    op_Subtrair:

    Devolve uma coleção apenas com as parametrizações que existam em ambas as coleções indicadas.

    Declaration
    InvBEArtigosArmazensStocks ManipularListas(BasBETiposGcp.enuOperacoesListasObjectos Operacao, InvBEArtigosArmazensStocks objBeColl1, InvBEArtigosArmazensStocks objBeColl2, bool blnPrioridade1)
    Parameters
    Type Name Description
    BasBETiposGcp.enuOperacoesListasObjectos Operacao

    Indica qual o tipo de manipulação que deve ser executada.

    InvBEArtigosArmazensStocks objBeColl1

    Primeira coleção com as parametrizações.

    InvBEArtigosArmazensStocks objBeColl2

    Segunda coleção com as parametrizações.

    System.Boolean blnPrioridade1

    Indica qual a parametrização que deve ser devolvida na operação Adicionar. True - Primeira; False - Segunda

    Returns
    Type Description
    InvBEArtigosArmazensStocks

    Coleçao com as parametrizações manipuladas segundo a operação indicada.

    PreencheCamposDefeito(ref InvBEArtigoArmazemStock)

    Preenche os valores por omissão nas propriedades do objeto, caso não estejam preenchidos.

    Declaration
    InvBEArtigoArmazemStock PreencheCamposDefeito(ref InvBEArtigoArmazemStock objBE)
    Parameters
    Type Name Description
    InvBEArtigoArmazemStock objBE

    Objeto que identifica a parametrização.

    Returns
    Type Description
    InvBEArtigoArmazemStock

    Objeto que representa a parametrização com as respetivas propriedades preenchidas.

    PreencheCamposDefeitoLista(InvBEArtigosArmazensStocks)

    Preenche os valores por omissão nas propriedades de todos os objetos dentro da coleção, caso não estejam preenchidos.

    Declaration
    InvBEArtigosArmazensStocks PreencheCamposDefeitoLista(InvBEArtigosArmazensStocks objBeColl)
    Parameters
    Type Name Description
    InvBEArtigosArmazensStocks objBeColl

    Coleçao com as parametrizações.

    Returns
    Type Description
    InvBEArtigosArmazensStocks

    Coleçao com as parametrizações com as respetivas propriedades preenchidas.

    Remove(String, String)

    Remove uma parametrização.

    Declaration
    void Remove(string strArtigo, string strArmazem)
    Parameters
    Type Name Description
    System.String strArtigo

    Código do artigo (Artigo).

    System.String strArmazem

    Código do armazém (Armazem).

    RemoveFiltroArmazens(String, InvBEArtigosArmazensStocks)

    Devolve uma coleção de parametrizações filtrada pelo armazém indicado a partir da coleção indicada.

    Caso nenhuma coleção seja indicada, todas as parametrizações para o armazém indicado serão removidas.

    Declaration
    InvBEArtigosArmazensStocks RemoveFiltroArmazens(string strArmazem, InvBEArtigosArmazensStocks objBeCollOrg = null)
    Parameters
    Type Name Description
    System.String strArmazem

    Código do armazém (Armazem).

    InvBEArtigosArmazensStocks objBeCollOrg

    Coleção com as parametrizações (opcional).

    Returns
    Type Description
    InvBEArtigosArmazensStocks

    Coleçao com as parametrizações filtradas.

    RemoveFiltroArtigo(String, InvBEArtigosArmazensStocks)

    Devolve uma coleção de parametrizações filtrada pelo artigo indicado a partir da coleção indicada.

    Caso nenhuma coleção seja indicada, todas as parametrizações para o artigo indicado serão removidas.

    Declaration
    InvBEArtigosArmazensStocks RemoveFiltroArtigo(string strArtigo, InvBEArtigosArmazensStocks objBeCollOrg = null)
    Parameters
    Type Name Description
    System.String strArtigo

    Código do artigo (Artigo).

    InvBEArtigosArmazensStocks objBeCollOrg

    Coleção com as parametrizações (opcional).

    Returns
    Type Description
    InvBEArtigosArmazensStocks

    Coleçao com as parametrizações filtradas.

    ValidaActualizacao(InvBEArtigoArmazemStock, ref String)

    Valida a actualização de uma parametrização.

    Declaration
    bool ValidaActualizacao(InvBEArtigoArmazemStock objBE, ref string strErroValidacao)
    Parameters
    Type Name Description
    InvBEArtigoArmazemStock objBE

    Objeto que identifica a parametrização.

    System.String strErroValidacao

    Mensagens de erro devolvidas.

    Returns
    Type Description
    System.Boolean

    True - Validação com sucesso; False - Validação sem sucesso

    ValidaRemocao(String, String, ref String)

    Valida a remoção de uma parametrização.

    Declaration
    bool ValidaRemocao(string strArtigo, string strArmazem, ref string strErroValidacao)
    Parameters
    Type Name Description
    System.String strArtigo

    Código do artigo (Artigo).

    System.String strArmazem

    Código do armazém (Armazem).

    System.String strErroValidacao

    Mensagens de erro devolvidas.

    Returns
    Type Description
    System.Boolean

    True - Validação com sucesso; False - Validação sem sucesso