Interface IStpBSContratos

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

Namespace: IStpBS100

Assembly: IStpBS100.dll

Syntax

[ComVisible(true)]
[Guid("9BDC2650-8C87-4707-8EDA-1A9642B9B9C1")]
public interface IStpBSContratos

Methods

Actualiza(PcmBEContrato, StpBEContrato)

Actualiza a informação do Contrato.

Declaration

void Actualiza(PcmBEContrato ContratoPCM, StpBEContrato Contrato)

Parameters

Type	Name	Description
PcmBEContrato	ContratoPCM	Objecto contendo a informação actualizada do Contrato PCM.
StpBEContrato	Contrato	Objecto contendo a informação actualizada do Contrato STP.

Actualiza(PcmBEContrato, StpBEContrato, ref String)

Actualiza a informação do Contrato.

Declaration

void Actualiza(PcmBEContrato ContratoPCM, StpBEContrato Contrato, ref string Avisos)

Parameters

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

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	Identificador do Contrato.
System.String	Atributo	Nome do atributo cujo valor será actualizado.
System.Object	Valor	Valor do atributo que será actualizado.

ActualizaValorAtributosId(String, StdBECampos)

Actualiza os valores respectivos de um conjunto de atributos.

Declaration

void ActualizaValorAtributosId(string Id, StdBECampos Atributos)

Parameters

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

ClonaContrato(StpBEContrato, String)

Devolve o clone de um Contrato.

Declaration

StpBEContrato ClonaContrato(StpBEContrato Contrato, string NovoID)

Parameters

Type	Name	Description
StpBEContrato	Contrato	Objecto contendo o Contrato a clonar.
System.String	NovoID	Identificador para o novo Contrato (clone).

Returns

Type	Description
StpBEContrato

ContratoValido(String, String)

Verifica se um Contrato é válido.

Declaration

bool ContratoValido(string ContratoID, string ErrosValidacao)

Parameters

Type	Name	Description
System.String	ContratoID	Identificador do Contrato a verificar.
System.String	ErrosValidacao	Mensagens de erro detectados no processo de verificação.

Returns

Type	Description
System.Boolean

ContratoValidoEx(String, DateTime, String)

Verifica se um Contrato é válido para uma determinada data.

Declaration

bool ContratoValidoEx(string ContratoID, DateTime DataValidacao, string ErrosValidacao)

Parameters

Type	Name	Description
System.String	ContratoID	Identificador do Contrato a verificar.
System.DateTime	DataValidacao	Data a verificar.
System.String	ErrosValidacao	Mensagens de erro detectados no processo de verificação.

Returns

Type	Description
System.Boolean

DaDefCamposUtil()

Devolve as definições dos campos do utilizador.

Declaration

StdBEDefCamposUtil DaDefCamposUtil()

Returns

Type	Description
StdBEDefCamposUtil

DaValorAtributoID(String, String)

Devolve o valor de um atributo.

Declaration

dynamic DaValorAtributoID(string Id, string Atributo)

Parameters

Type	Name	Description
System.String	Id	Identificador do Contrato.
System.String	Atributo	Nome do atributo cujo valor será devolvido.

Returns

Type	Description
System.Object

DaValorAtributosID(String, Object[])

Devolve o valor de um conjunto de atributos.

Declaration

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

Parameters

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

Returns

Type	Description
StdBECampos

DuplicaContrato(StpBEContrato, String)

Devolve um Contrato a partir de um original.

Declaration

StpBEContrato DuplicaContrato(StpBEContrato Contrato, string NovoID)

Parameters

Type	Name	Description
StpBEContrato	Contrato	Contrato a duplicar.
System.String	NovoID	Identificador para o novo Contrato (duplicado).

Returns

Type	Description
StpBEContrato

EditaId(String)

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

Declaration

StpBEContrato EditaId(string Id)

Parameters

Type	Name	Description
System.String	Id	Identificador do Contrato.

Returns

Type	Description
StpBEContrato

ExisteContratoObjecto(String, Boolean, Boolean)

Verifica se existe um Contrato para um Objecto.

Declaration

bool ExisteContratoObjecto(string ObjectoID, bool ConsideraContratosNovosEOrcamentados, bool ConsideraContratosCancelados)

Parameters

Type	Name	Description
System.String	ObjectoID	Identificador do Objecto.
System.Boolean	ConsideraContratosNovosEOrcamentados	Indica se deve considerar Contratos novos e orçamentados.
System.Boolean	ConsideraContratosCancelados	Indica se deve considerar Contratos cancelados.

Returns

Type	Description
System.Boolean

ExisteContratoObjectoEx(String, String, String)

Verifica se existe um Contrato para um Cliente e um Objecto.

Declaration

bool ExisteContratoObjectoEx(string Cliente, string IDObjecto, string IDLinhaContratoExcluir)

Parameters

Type	Name	Description
System.String	Cliente	Identificador do Cliente.
System.String	IDObjecto	Identificador (GUID) do Objecto.
System.String	IDLinhaContratoExcluir	Identificador de linha para excluir da validação.

Returns

Type	Description
System.Boolean

ExisteId(String)

Verifica se existe o Contrato.

Declaration

bool ExisteId(string Id)

Parameters

Type	Name	Description
System.String	Id	Identificador do Contrato.

Returns

Type	Description
System.Boolean

RemoveID(String)

Remove o Contrato.

Declaration

void RemoveID(string Id)

Parameters

Type	Name	Description
System.String	Id	Identificador do Contrato.

RenovaContrato(PcmBEContrato, PcmBEContrato, String)

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

Declaration

bool RenovaContrato(PcmBEContrato Contrato, PcmBEContrato Renovacao, string Avisos)

Parameters

Type	Name	Description
PcmBEContrato	Contrato	Objecto contendo o Contrato PCM a renovar.
PcmBEContrato	Renovacao	Objecto contendo o Contrato PCM renovado.
System.String	Avisos	Mensagens de aviso detectadas no processo de renovação.

Returns

Type	Description
System.Boolean

ValidaActualizacao(PcmBEContrato, StpBEContrato, ref String, ref String)

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

Declaration

bool ValidaActualizacao(PcmBEContrato ContratoPCM, StpBEContrato Contrato, ref string ErroValidacao, ref string Avisos)

Parameters

Type	Name	Description
PcmBEContrato	ContratoPCM	Objecto contendo a informação do Contrato PCM que se pretende validar.
StpBEContrato	Contrato	Objecto contendo a informação do Contrato STP que se pretende validar.
System.String	ErroValidacao	Recebe a descrição de eventuais erros detectados.
System.String	Avisos	Recebe a descrição de eventuais avisos detectados.

Returns

Type	Description
System.Boolean

ValidaActualizacaoAgendamentoIntervencoes(StpBEObjectoContrato, ref String)

Efectua a validação da informação de um agendamento de intervenção para um Objecto de um Contrato.

Declaration

bool ValidaActualizacaoAgendamentoIntervencoes(StpBEObjectoContrato objBE, ref string ErroValidacao)

Parameters

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

Returns

Type	Description
System.Boolean

ValidaRemocao(String, ref String)

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

Declaration

bool ValidaRemocao(string ContratoID, ref string ErroValidacao)

Parameters

Type	Name	Description
System.String	ContratoID	Identificador do Contrato.
System.String	ErroValidacao	Recebe a descrição de eventuais erros detectados.

Returns

Type	Description
System.Boolean