Interface IPcmBSContratos

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

Namespace: IPcmBS100

Assembly: IPcmBS100.dll

Syntax

[ComVisible(true)]
[Guid("F550EA76-6722-459D-AAFD-05FCCF7E41D4")]
public interface IPcmBSContratos

Methods

Actualiza(PcmBEContrato)

Actualiza a informação do contrato.

Declaration

void Actualiza(PcmBEContrato Contrato)

Parameters

Type	Name	Description
PcmBEContrato	Contrato	Objecto contendo a informação actualizada do contrato.

Actualiza(PcmBEContrato, ref String)

Actualiza a informação do contrato.

Declaration

void Actualiza(PcmBEContrato Contrato, ref string Avisos)

Parameters

Type	Name	Description
PcmBEContrato	Contrato	Objecto contendo a informação actualizada do contrato.
System.String	Avisos	Notificação devolvida pelo processo de actualização.

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

Actualiza o valor de um atributo.

Declaration

void ActualizaValorAtributo(string TipoDoc, string Serie, int NumContrato, string Filial, string Atributo, dynamic Valor)

Parameters

Type	Name	Description
System.String	TipoDoc	Identificador do tipo de documento.
System.String	Serie	Identificador da série.
System.Int32	NumContrato	Identificador do número do contrato.
System.String	Filial	Identificador da filial.
System.String	Atributo	Nome do atributo cujo valor será actualizado.
System.Object	Valor	Valor do atributo que será actualizado.

ActualizaValorAtributoId(String, String, Object)

Actualiza o valor de um atributo.

Declaration

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

Parameters

Type	Name	Description
System.String	Id
System.String	Atributo	Nome do atributo cujo valor será actualizado.
System.Object	Valor	Valor do atributo que será actualizado.

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

Actualiza os valores respectivos de um conjunto de atributos.

Declaration

void ActualizaValorAtributos(string TipoDoc, string Serie, int NumContrato, string Filial, StdBECampos Atributos)

Parameters

Type	Name	Description
System.String	TipoDoc	Identificador do tipo de documento.
System.String	Serie	Identificador da série.
System.Int32	NumContrato	Identificador do número do contrato.
System.String	Filial	Identificador da filial.
StdBECampos	Atributos	Identifica os atributos e os respectivos valores a actualizar.

ActualizaValorAtributosId(String, StdBECampos)

Actualiza o valor de um conjunto de atributos.

Declaration

void ActualizaValorAtributosId(string Id, StdBECampos Atributos)

Parameters

Type	Name	Description
System.String	Id
StdBECampos	Atributos	Identifica os atributos e os respectivos valores a actualizar.

ActualizaXmlFicheiroWord(String, String)

Insere ou actualiza o conteúdo do ficheiro Word para mapeamento do contrato.

Declaration

bool ActualizaXmlFicheiroWord(string FicheiroWord, string IdContrato)

Parameters

Type	Name	Description
System.String	FicheiroWord	Caminho do ficheiro Word.
System.String	IdContrato	Identificador do contrato.

Returns

Type	Description
System.Boolean

ClonaContrato(PcmBEContrato)

Clona um contrato e retorna o clone.

Declaration

PcmBEContrato ClonaContrato(PcmBEContrato Contrato)

Parameters

Type	Name	Description
PcmBEContrato	Contrato	Objecto contendo a informação que se pretende clonar.

Returns

Type	Description
PcmBEContrato

CriaVersaoContrato(String)

Cria uma nova versão para um contrato e retorna o ID da versão de histórico.

Declaration

string CriaVersaoContrato(string Id)

Parameters

Type	Name	Description
System.String	Id

Returns

Type	Description
System.String

DaDefCamposUtil()

Devolve as definições dos campos do utilizador.

Declaration

StdBEDefCamposUtil DaDefCamposUtil()

Returns

Type	Description
StdBEDefCamposUtil

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

Devolve o valor de um atributo.

Declaration

dynamic DaValorAtributo(string TipoDoc, string Serie, int NumContrato, string Filial, string Atributo)

Parameters

Type	Name	Description
System.String	TipoDoc	Identificador do tipo de documento.
System.String	Serie	Identificador da série.
System.Int32	NumContrato	Identificador do número do contrato.
System.String	Filial	Identificador da filial.
System.String	Atributo	Nome do atributo cujo valor será devolvido.

Returns

Type	Description
System.Object

DaValorAtributoID(String, String)

Devolve o valor de um atributo com base na chave física (ID).

Declaration

dynamic DaValorAtributoID(string Id, string Atributo)

Parameters

Type	Name	Description
System.String	Id
System.String	Atributo	Nome do atributo do qual se pretende obter o valor.

Returns

Type	Description
System.Object

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

Devolve o valor de um conjunto de atributos.

Declaration

StdBECampos DaValorAtributos(string TipoDoc, string Serie, int NumContrato, string Filial, params dynamic[] Atributos)

Parameters

Type	Name	Description
System.String	TipoDoc	Identificador do tipo de documento.
System.String	Serie	Identificador da série.
System.Int32	NumContrato	Identificador do número do contrato.
System.String	Filial	Identificador da filial.
System.Object[]	Atributos	Conjunto de atributos para os quais se pretende obter o valor.

Returns

Type	Description
StdBECampos

DaValorAtributosID(String, Object[])

Devolve o valor de um conjunto de atributos com base na chave física (ID).

Declaration

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

Parameters

Type	Name	Description
System.String	Id
System.Object[]	Atributos	Conjunto de atributos dos quais se pretende obter o valor.

Returns

Type	Description
StdBECampos

DuplicaContrato(PcmBEContrato)

Devolve um contrato a partir de um original.

Declaration

PcmBEContrato DuplicaContrato(PcmBEContrato Contrato)

Parameters

Type	Name	Description
PcmBEContrato	Contrato	Contrato a duplicar.

Returns

Type	Description
PcmBEContrato

Edita(String, String, Int32, String)

Edita a informação do contrato.

Declaration

PcmBEContrato Edita(string TipoDoc, string Serie, int NumContrato, string Filial)

Parameters

Type	Name	Description
System.String	TipoDoc	Identificador do tipo de documento.
System.String	Serie	Identificador da série.
System.Int32	NumContrato	Identificador do número do contrato.
System.String	Filial	Identificador da filial.

Returns

Type	Description
PcmBEContrato

EditaCodigo(String)

Edita a informação do contrato na última versão.

Declaration

PcmBEContrato EditaCodigo(string Codigo)

Parameters

Type	Name	Description
System.String	Codigo	Código do contrato.

Returns

Type	Description
PcmBEContrato

EditaCodigoVersao(String, Int32)

Edita a informação do contrato.

Declaration

PcmBEContrato EditaCodigoVersao(string Codigo, int Versao)

Parameters

Type	Name	Description
System.String	Codigo	Código do contrato.
System.Int32	Versao

Returns

Type	Description
PcmBEContrato

EditaId(String)

Edita a informação do contrato com base na chave física (ID).

Declaration

PcmBEContrato EditaId(string Id)

Parameters

Type	Name	Description
System.String	Id

Returns

Type	Description
PcmBEContrato

EditaVersao(String, String, Int32, String, Int32)

Edita a informação do contrato.

Declaration

PcmBEContrato EditaVersao(string TipoDoc, string Serie, int NumContrato, string Filial, int Versao)

Parameters

Type	Name	Description
System.String	TipoDoc	Identificador do tipo de documento.
System.String	Serie	Identificador da série.
System.Int32	NumContrato	Identificador do número do contrato.
System.String	Filial	Identificador da filial.
System.Int32	Versao	Identificador da versão.

Returns

Type	Description
PcmBEContrato

Existe(String, String, Int32, String)

Verifica se existe o contrato.

Declaration

bool Existe(string TipoDoc, string Serie, int NumContrato, string Filial)

Parameters

Type	Name	Description
System.String	TipoDoc	Identificador do tipo de documento.
System.String	Serie	Identificador da série.
System.Int32	NumContrato	Identificador do número do contrato.
System.String	Filial	Identificador da filial.

Returns

Type	Description
System.Boolean

ExisteCodigo(String)

Verifica se existe o contrato.

Declaration

bool ExisteCodigo(string Codigo)

Parameters

Type	Name	Description
System.String	Codigo	Identificador do código do contrato.

Returns

Type	Description
System.Boolean

ExisteContratoEntidade(String, String)

Verifica se existe algum contrato válido (não cancelado) associado a uma entidade.

Declaration

bool ExisteContratoEntidade(string TipoEntidade, string Entidade)

Parameters

Type	Name	Description
System.String	TipoEntidade	Identificador do tipo de entidade.
System.String	Entidade	Identificador da entidade.

Returns

Type	Description
System.Boolean

ExisteId(String)

Verifica se existe o contrato.

Declaration

bool ExisteId(string Id)

Parameters

Type	Name	Description
System.String	Id

Returns

Type	Description
System.Boolean

ExisteReferencia(String)

Devolve verdadeiro se a referência já existe associada a algum contrato.

Declaration

bool ExisteReferencia(string Referencia)

Parameters

Type	Name	Description
System.String	Referencia	Referência a validar.

Returns

Type	Description
System.Boolean

ExisteVersao(String, String, Int32, String, Int32)

Verifica se existe o contrato na versão indicada.

Declaration

bool ExisteVersao(string TipoDoc, string Serie, int NumContrato, string Filial, int Versao)

Parameters

Type	Name	Description
System.String	TipoDoc	Identificador do tipo de documento.
System.String	Serie	Identificador da série.
System.Int32	NumContrato	Identificador do número do contrato.
System.String	Filial	Identificador da filial.
System.Int32	Versao	Identificador da versão.

Returns

Type	Description
System.Boolean

GarantiasValidas(String, String, Int32, String, DateTime, PcmBEContrato)

Valida se as garantias do contrato se encontram válidas

Declaration

bool GarantiasValidas(string TipoDoc, string Serie, int NumContrato, string Filial, DateTime Data, PcmBEContrato Contrato = null)

Parameters

Type	Name	Description
System.String	TipoDoc	Tipo de contrato
System.String	Serie	Série do contrato
System.Int32	NumContrato	Número do contrato
System.String	Filial	Filial
System.DateTime	Data	Data de referência para a validação
PcmBEContrato	Contrato	Objecto com o contrato já editado (opcional)

Returns

Type	Description
System.Boolean	true (se garantias válidas), false (caso contrário)

LstContratosDatas(DateTime, DateTime)

Devolve a lista de Contratos entre duas datas.

Declaration

StdBELista LstContratosDatas(DateTime DataInicio, DateTime DataFim)

Parameters

Type	Name	Description
System.DateTime	DataInicio	Data inicial do período.
System.DateTime	DataFim	Data final do período.

Returns

Type	Description
StdBELista

LstContratosEntidade(String, String)

Devolve a lista de Contratos de uma determinada entidade.

Declaration

StdBELista LstContratosEntidade(string TipoEntidade, string Entidade)

Parameters

Type	Name	Description
System.String	TipoEntidade	Identificador do Tipo de Entidade.
System.String	Entidade	Identificador da Entidade.

Returns

Type	Description
StdBELista

LstContratosEntidadeDatas(String, String, Object, Object)

Devolve os Contratos de uma determinada Entidade de acordo com um intervalo de datas.

Declaration

StdBELista LstContratosEntidadeDatas(string TipoEntidade, string Entidade, dynamic DataInicio, dynamic DataFim)

Parameters

Type	Name	Description
System.String	TipoEntidade	Identificador do Tipo de Entidade.
System.String	Entidade	Identificador da Entidade.
System.Object	DataInicio	Identificador da Data inicial.
System.Object	DataFim	Identificador da Data final.

Returns

Type	Description
StdBELista

LstContratosTodos()

Devolve a lista de todos os Contratos.

Declaration

StdBELista LstContratosTodos()

Returns

Type	Description
StdBELista

Remove(String, String, Int32, String)

Remove o contrato.

Declaration

void Remove(string TipoDoc, string Serie, int NumContrato, string Filial)

Parameters

Type	Name	Description
System.String	TipoDoc	Identificador do Tipo de Documento.
System.String	Serie	Identificador da Série.
System.Int32	NumContrato	Identificador do número do Contrato.
System.String	Filial	Identificador da Filial.

RenovaContrato(String, ref String, DateTime, DateTime, PcmBETipos.PcmEstadoContrato, String, String)

Renova um contrato. A renovação cria um novo contrato com a mesma referência para um novo período.

Declaration

void RenovaContrato(string ContratoID, ref string RenovacaoID, DateTime NovaDataInicio, DateTime NovaDataFim, PcmBETipos.PcmEstadoContrato NovoEstado, string NovoTipoDeDocumento = "", string NovaSerie = "")

Parameters

Type	Name	Description
System.String	ContratoID	ID do contrato a renovar
System.String	RenovacaoID	ID para a renovação
System.DateTime	NovaDataInicio	Data de início do período
System.DateTime	NovaDataFim	Data de fim do perído
PcmBETipos.PcmEstadoContrato	NovoEstado	Estado para o contrato renovado
System.String	NovoTipoDeDocumento	Tipo de documento para a renovação
System.String	NovaSerie	Série para a renovação

ValidaActualizacao(PcmBEContrato, ref String)

Efectua a validação da informação do contrato.

Declaration

bool ValidaActualizacao(PcmBEContrato Contrato, ref string ErroValidacao)

Parameters

Type	Name	Description
PcmBEContrato	Contrato	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, Int32, String, ref String)

Efectua as validações necessárias à remoção do contrato.

Declaration

bool ValidaRemocao(string TipoDoc, string Serie, int NumContrato, string Filial, ref string ErroValidacao)

Parameters

Type	Name	Description
System.String	TipoDoc	Identificador do tipo de documento.
System.String	Serie	Identificador da série.
System.Int32	NumContrato	Identificador do número do contrato.
System.String	Filial	Identificador da filial.
System.String	ErroValidacao	Recebe a descrição de eventuais erros detectados.

Returns

Type	Description
System.Boolean