Interface IPcmBSSeriesContratos

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

Namespace: IPcmBS100

Assembly: IPcmBS100.dll

Syntax

[ComVisible(true)]
[Guid("277F8666-ED1C-4170-AF07-76E647660485")]
public interface IPcmBSSeriesContratos

Methods

Actualiza(PcmBESerieContrato, String)

Actualiza a informação da Série.

Declaration

void Actualiza(PcmBESerieContrato objBE, string Avisos = "")

Parameters

Type	Name	Description
PcmBESerieContrato	objBE	Objecto contendo a informação actualizada da Série.
System.String	Avisos	Notificação devolvida pelo processo de actualização.

ActualizaNumerador(String, String, Int32)

Permite efectuar a actualização do numerador de uma determinada série.

Declaration

void ActualizaNumerador(string Documento, string Serie, int Numerador)

Parameters

Type	Name	Description
System.String	Documento	Código do documento.
System.String	Serie	Série de documento a pesquisar.
System.Int32	Numerador	Número para actualizar a numeração.

ActualizaValorAtributo(String, String, String, Object)

Actualiza o valor de um atributo.

Declaration

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

Parameters

Type	Name	Description
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, StdBECampos)

Actualiza os valores respectivos de um conjunto de atributos.

Declaration

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

Parameters

Type	Name	Description
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()

Devolve as definições dos campos do utilizador.

Declaration

StdBEDefCamposUtil DaDefCamposUtil()

Returns

Type	Description
StdBEDefCamposUtil

DaSerieDefeito(String)

Devolve a série por defeito de um determinado documento.

Declaration

string DaSerieDefeito(string Documento)

Parameters

Type	Name	Description
System.String	Documento	Código do documento.

Returns

Type	Description
System.String

DaValorAtributo(String, String, String)

Devolve o valor de um atributo.

Declaration

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

Parameters

Type	Name	Description
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, Object[])

Devolve o valor de um conjunto de atributos.

Declaration

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

Parameters

Type	Name	Description
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)

Edita a informação da Série.

Declaration

PcmBESerieContrato Edita(string Documento, string Serie)

Parameters

Type	Name	Description
System.String	Documento	Código do documento.
System.String	Serie	Série de documento a pesquisar.

Returns

Type	Description
PcmBESerieContrato

Existe(String, String)

Verifica se existe a Série.

Declaration

bool Existe(string Documento, string Serie)

Parameters

Type	Name	Description
System.String	Documento	Código do documento.
System.String	Serie	Série de documento a pesquisar.

Returns

Type	Description
System.Boolean

ListaSeries(String)

Devolve a lista de todas as séries de um determinado documento.

Declaration

PcmBESeriesContrato ListaSeries(string Documento)

Parameters

Type	Name	Description
System.String	Documento	Código do documento.

Returns

Type	Description
PcmBESeriesContrato

ProximoNumero(String, String, Boolean)

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

Declaration

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

Parameters

Type	Name	Description
System.String	Documento	Código do documento.
System.String	Serie	Série de documento a pesquisar.
System.Boolean	LockRegisto

Returns

Type	Description
System.Int32

Remove(String, String)

Remove a Série.

Declaration

void Remove(string Documento, string Serie)

Parameters

Type	Name	Description
System.String	Documento	Código do documento.
System.String	Serie	Série de documento a pesquisar.

RemoveSeries(String)

Remove todas as séries de um determinado documento.

Declaration

void RemoveSeries(string Documento)

Parameters

Type	Name	Description
System.String	Documento	Código do documento.

SerieInactiva(String, String)

Verifica se uma determinada série está inactiva.

Declaration

bool SerieInactiva(string Documento, string Serie)

Parameters

Type	Name	Description
System.String	Documento	Código do documento.
System.String	Serie	Série de documento a pesquisar.

Returns

Type	Description
System.Boolean

SerieReferenciada(String, String)

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

Declaration

bool SerieReferenciada(string Documento, string Serie)

Parameters

Type	Name	Description
System.String	Documento	Código do documento.
System.String	Serie	Série de documento a pesquisar.

Returns

Type	Description
System.Boolean

ValidaActualizacao(PcmBESerieContrato, ref String)

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

Declaration

bool ValidaActualizacao(PcmBESerieContrato objBE, ref string ErroValidacao)

Parameters

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

Returns

Type	Description
System.Boolean

ValidaRemocao(String, String, ref String)

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

Declaration

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

Parameters

Type	Name	Description
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