Interface IStpBSSeries

Classe utilizada para obter serviços e regras de negócio sobre Séries.

Namespace: IStpBS100

Assembly: IStpBS100.dll

Syntax

[ComVisible(true)]
[Guid("6A074568-707F-4AC0-A7A0-EB1A5F03095C")]
public interface IStpBSSeries

Methods

Actualiza(String, StpBESerie, String)

Actualiza a informação da Série.

Declaration

void Actualiza(string Modulo, StpBESerie objSerie, string Avisos = "")

Parameters

Type	Name	Description
System.String	Modulo	Identificador do Módulo: S-Stocks, V-Vendas, C-Compras, B-Tesouraria, M-Contas Correntes.
StpBESerie	objSerie	Objecto contendo a informação actualizada da Série.
System.String	Avisos	Notificação devolvida pelo processo de actualização.

ActualizaNumerador(String, String, String, Int32, DateTime)

Actualiza o numerador de uma determinada Série.

Declaration

void ActualizaNumerador(string Modulo, string Documento, string Serie, int NumDoc, DateTime Data)

Parameters

Type	Name	Description
System.String	Modulo	Identificador do Módulo: S-Stocks, V-Vendas, C-Compras, B-Tesouraria, M-Contas Correntes.
System.String	Documento	Código do Documento.
System.String	Serie	Série de Documento a pesquisar.
System.Int32	NumDoc	Número para actualizar a numeração.
System.DateTime	Data	Data do Documento.

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

Actualiza o valor de um atributo.

Declaration

void ActualizaValorAtributo(string Modulo, string Documento, string Serie, string Atributo, dynamic Valor)

Parameters

Type	Name	Description
System.String	Modulo	Identificador do Módulo: S-Stocks, V-Vendas, C-Compras, B-Tesouraria, M-Contas Correntes.
System.String	Documento	Código do Documento.
System.String	Serie	Série de Documento a pesquisar.
System.String	Atributo	Nome do atributo cujo valor será actualizado.
System.Object	Valor	Valor do atributo que será actualizado.

ActualizaValorAtributos(String, String, String, StdBECampos)

Actualiza os valores respectivos de um conjunto de atributos.

Declaration

void ActualizaValorAtributos(string Modulo, string Documento, string Serie, StdBECampos Atributos)

Parameters

Type	Name	Description
System.String	Modulo	Identificador do Módulo: S-Stocks, V-Vendas, C-Compras, B-Tesouraria, M-Contas Correntes.
System.String	Documento	Código do Documento.
System.String	Serie	Série de Documento a pesquisar.
StdBECampos	Atributos	Identifica os atributos e os respectivos valores a actualizar.

DaDefCamposUtil(String)

Devolve as definições dos campos do utilizador.

Declaration

StdBEDefCamposUtil DaDefCamposUtil(string Modulo)

Parameters

Type	Name	Description
System.String	Modulo

Returns

Type	Description
StdBEDefCamposUtil

DaSerieDefeito(String, String)

Devolve a Série por defeito de um determinado Documento.

Declaration

string DaSerieDefeito(string Modulo, string Documento)

Parameters

Type	Name	Description
System.String	Modulo	Identificador do Módulo: S-Stocks, V-Vendas, C-Compras, B-Tesouraria, M-Contas Correntes.
System.String	Documento	Código do Documento.

Returns

Type	Description
System.String

DaValorAtributo(String, String, String, String)

Devolve o valor de um atributo.

Declaration

dynamic DaValorAtributo(string Modulo, string Documento, string Serie, string Atributo)

Parameters

Type	Name	Description
System.String	Modulo	Identificador do Módulo: S-Stocks, V-Vendas, C-Compras, B-Tesouraria, M-Contas Correntes.
System.String	Documento	Código do Documento.
System.String	Serie	Série de Documento a pesquisar.
System.String	Atributo	Nome do atributo cujo valor será devolvido.

Returns

Type	Description
System.Object

DaValorAtributos(String, String, String, Object[])

Devolve o valor de um conjunto de atributos.

Declaration

StdBECampos DaValorAtributos(string Modulo, string Documento, string Serie, params dynamic[] Atributos)

Parameters

Type	Name	Description
System.String	Modulo	Identificador do Módulo: S-Stocks, V-Vendas, C-Compras, B-Tesouraria, M-Contas Correntes.
System.String	Documento	Código do Documento.
System.String	Serie	Série de Documento a pesquisar.
System.Object[]	Atributos	Conjunto de atributos dos quais se pretende obter o valor.

Returns

Type	Description
StdBECampos

Edita(String, String, String)

Edita a informação da Série.

Declaration

StpBESerie Edita(string Modulo, string Documento, string Serie)

Parameters

Type	Name	Description
System.String	Modulo	Identificador do Módulo: S-Stocks, V-Vendas, C-Compras, B-Tesouraria, M-Contas Correntes.
System.String	Documento	Código do Documento.
System.String	Serie	Série de Documento a pesquisar.

Returns

Type	Description
StpBESerie

Existe(String, String, String)

Verifica se existe a Série.

Declaration

bool Existe(string Modulo, string Documento, string Serie)

Parameters

Type	Name	Description
System.String	Modulo	Identificador do Módulo: S-Stocks, V-Vendas, C-Compras, B-Tesouraria, M-Contas Correntes.
System.String	Documento	Código do Documento.
System.String	Serie	Série de Documento a pesquisar.

Returns

Type	Description
System.Boolean

ListaSeries(String, String)

Devolve a lista de todas as Séries de um determinado Documento.

Declaration

StpBESeries ListaSeries(string Modulo, string Documento)

Parameters

Type	Name	Description
System.String	Modulo	Identificador do Módulo: S-Stocks, V-Vendas, C-Compras, B-Tesouraria, M-Contas Correntes.
System.String	Documento	Código do Documento.

Returns

Type	Description
StpBESeries

ProximoNumero(String, String, String, Boolean)

Devolve o próximo número da Série.

Declaration

int ProximoNumero(string Modulo, string Documento, string Serie, bool LockRegisto = false)

Parameters

Type	Name	Description
System.String	Modulo	Identificador do Módulo: S-Stocks, V-Vendas, C-Compras, B-Tesouraria, M-Contas Correntes.
System.String	Documento	Código do Documento.
System.String	Serie	Série de Documento a pesquisar.
System.Boolean	LockRegisto	Indica se bloqueia o registo.

Returns

Type	Description
System.Int32

Remove(String, String, String)

Remove a Série.

Declaration

void Remove(string Modulo, string Documento, string Serie)

Parameters

Type	Name	Description
System.String	Modulo	Identificador do Módulo: S-Stocks, V-Vendas, C-Compras, B-Tesouraria, M-Contas Correntes.
System.String	Documento	Código do Documento.
System.String	Serie	Série de Documento a pesquisar.

RemoveSeries(String, String)

Remove todas as Séries de um determinado Documento.

Declaration

void RemoveSeries(string Modulo, string Documento)

Parameters

Type	Name	Description
System.String	Modulo	Identificador do Módulo: S-Stocks, V-Vendas, C-Compras, B-Tesouraria, M-Contas Correntes.
System.String	Documento	Código do Documento.

SerieInactiva(String, String, String)

Verifica se uma determinada Série está inactiva.

Declaration

bool SerieInactiva(string Modulo, string Documento, string Serie)

Parameters

Type	Name	Description
System.String	Modulo	Identificador do Módulo: S-Stocks, V-Vendas, C-Compras, B-Tesouraria, M-Contas Correntes.
System.String	Documento	Código do Documento.
System.String	Serie	Série de Documento a pesquisar.

Returns

Type	Description
System.Boolean

SerieReferenciada(String, String, String)

Verifica se a Série já está em uso.

Declaration

bool SerieReferenciada(string Modulo, string Documento, string Serie)

Parameters

Type	Name	Description
System.String	Modulo	Identificador do Módulo: S-Stocks, V-Vendas, C-Compras, B-Tesouraria, M-Contas Correntes.
System.String	Documento	Código do Documento.
System.String	Serie	Série de Documento a pesquisar.

Returns

Type	Description
System.Boolean

SugereDataDocumento(String, String, String)

Devolve a data sugerida para o Documento.

Declaration

DateTime SugereDataDocumento(string Modulo, string Documento, string Serie)

Parameters

Type	Name	Description
System.String	Modulo	Identificador do Módulo: S-Stocks, V-Vendas, C-Compras, B-Tesouraria, M-Contas Correntes.
System.String	Documento	Código do Documento.
System.String	Serie	Série de Documento a pesquisar.

Returns

Type	Description
System.DateTime

ValidaActualizacao(StpBESerie, ref String)

Efectua a validação da informação da Série.

Declaration

bool ValidaActualizacao(StpBESerie objBE, ref string ErroValidacao)

Parameters

Type	Name	Description
StpBESerie	objBE	Objecto contendo a informação da Série que se pretende validar.
System.String	ErroValidacao	Recebe a descrição de eventuais erros detectados.

Returns

Type	Description
System.Boolean

ValidaRemocao(String, String, String, ref String)

Efectua as validações necessárias à remoção da Série.

Declaration

bool ValidaRemocao(string Modulo, string Documento, string Serie, ref string ErroValidacao)

Parameters

Type	Name	Description
System.String	Modulo	Identificador do Módulo: S-Stocks, V-Vendas, C-Compras, B-Tesouraria, M-Contas Correntes.
System.String	Documento	Código do Documento.
System.String	Serie	Série de Documento a pesquisar.
System.String	ErroValidacao	Recebe a descrição de eventuais erros detectados.

Returns

Type	Description
System.Boolean