Interface IRhpBSPeriodos
Classe utilizada para obter as regras de negócio dos Períodos de Processamento.
Namespace: IRhpBS100
Assembly: IRhpBS100.dll
Syntax
[ComVisible(true)]
[Guid("D9219949-5D7E-4FFA-820E-C296B8A1D155")]
public interface IRhpBSPeriodos
Methods
Actualiza(RhpBEPeriodo)
Actualiza a informação de um período de processamento.
Declaration
void Actualiza(RhpBEPeriodo objBEPeriodo)
Parameters
Type | Name | Description |
---|---|---|
RhpBEPeriodo | objBEPeriodo | Objecto contendo os valores actuais. |
ActualizaValorAtributo(String, String, Object)
Actualiza o valor de um atributo.
Declaration
void ActualizaValorAtributo(string Periodo, string Atributo, object Valor)
Parameters
Type | Name | Description |
---|---|---|
System.String | Periodo | Identificador do período. |
System.String | Atributo | Nome do atributo cujo valor será actualizado. |
System.Object | Valor | Novo valor do atributo indicado. |
ActualizaValorAtributos(String, StdBECampos)
Actualiza os valores respectivos de um conjunto de atributos.
Declaration
void ActualizaValorAtributos(string Periodo, StdBECampos Atributos)
Parameters
Type | Name | Description |
---|---|---|
System.String | Periodo | Identificador do período. |
StdBECampos | Atributos | Objecto contendo os atributos a actualizar e respectivos valores. |
DaAnoDoPeriodoDeUmaData(String, DateTime)
Devolve o ano do período ao qual pertence uma data.
Declaration
int DaAnoDoPeriodoDeUmaData(string Periodo, DateTime Data)
Parameters
Type | Name | Description |
---|---|---|
System.String | Periodo | Identificador do período. |
System.DateTime | Data | Data a pesquisar. |
Returns
Type | Description |
---|---|
System.Int32 |
DaAnoeNumPeriodoData(String, DateTime, ref Int32, ref Int32)
Devolve o ano e número do período ao qual pertence uma data.
Declaration
void DaAnoeNumPeriodoData(string sPeriodo, DateTime dtData, ref int iretAno, ref int iretNumPeriodo)
Parameters
Type | Name | Description |
---|---|---|
System.String | sPeriodo | |
System.DateTime | dtData | |
System.Int32 | iretAno | retorna o ano do período ao qual pertence a data. |
System.Int32 | iretNumPeriodo | retorna o número do período ao qual pertence a data. |
DaDataFimPeriodo(String, Int32, Int32)
Devolve a data de finalização de um determinado período.
Declaration
DateTime DaDataFimPeriodo(string Periodo, int Ano, int Mes)
Parameters
Type | Name | Description |
---|---|---|
System.String | Periodo | Identificador do período. |
System.Int32 | Ano | para o qual o período é válido. |
System.Int32 | Mes | Mês do período. |
Returns
Type | Description |
---|---|
System.DateTime |
DaDataInicioPeriodo(String, Int32, Int32)
Devolve a data de início de um determinado período.
Declaration
DateTime DaDataInicioPeriodo(string Periodo, int Ano, int Mes)
Parameters
Type | Name | Description |
---|---|---|
System.String | Periodo | Identificador do período. |
System.Int32 | Ano | para o qual o período é válido. |
System.Int32 | Mes | Mês do período. |
Returns
Type | Description |
---|---|
System.DateTime |
DaDefCamposUtil()
Devolve as definições dos campos do utilizador.
Declaration
StdBEDefCamposUtil DaDefCamposUtil()
Returns
Type | Description |
---|---|
StdBEDefCamposUtil |
DaDescricaoDoPeriodoDetalhado(String, Int32, Int32)
Devolve a descrição do período do número de período pretendido.
Declaration
string DaDescricaoDoPeriodoDetalhado(string Periodo, int Ano, int NumPeriodo)
Parameters
Type | Name | Description |
---|---|---|
System.String | Periodo | Identificador do período. |
System.Int32 | Ano | para o qual o período é válido. |
System.Int32 | NumPeriodo | Número do período. |
Returns
Type | Description |
---|---|
System.String |
DaDiasProc30Dias(String, Int32, Int32)
Devolve o número de dias processados nos últimos 30 dias.
Declaration
int DaDiasProc30Dias(string Periodo, int Ano, int NumPeriodo)
Parameters
Type | Name | Description |
---|---|---|
System.String | Periodo | Identificador do período. |
System.Int32 | Ano | para o qual o período é válido. |
System.Int32 | NumPeriodo | Número do período. |
Returns
Type | Description |
---|---|
System.Int32 |
DaDiasUteis(String, Int32, Int32)
Devolve o número de dias úteis num determinado período.
Declaration
int DaDiasUteis(string Periodo, int Ano, int NumPeriodo)
Parameters
Type | Name | Description |
---|---|---|
System.String | Periodo | Identificador do período. |
System.Int32 | Ano | para o qual o período é válido. |
System.Int32 | NumPeriodo | Número do período. |
Returns
Type | Description |
---|---|
System.Int32 |
DaMesFiscalDeUmNumeroPeriodo(String, Int32, Int32)
Devolve o mês do respectivo período.
Declaration
int DaMesFiscalDeUmNumeroPeriodo(string Periodo, int Ano, int NumPeriodo)
Parameters
Type | Name | Description |
---|---|---|
System.String | Periodo | Identificador do período. |
System.Int32 | Ano | para o qual o período é válido. |
System.Int32 | NumPeriodo | Número do período. |
Returns
Type | Description |
---|---|
System.Int32 |
DaNumeroPeriodoData(String, Int32, DateTime)
Devolve o número do período da respectiva data.
Declaration
int DaNumeroPeriodoData(string Periodo, int Ano, DateTime Data)
Parameters
Type | Name | Description |
---|---|---|
System.String | Periodo | Identificador do período. |
System.Int32 | Ano | para o qual o período é válido. |
System.DateTime | Data | Data a pesquisar. |
Returns
Type | Description |
---|---|
System.Int32 |
DaNumeroPeriodosMesFiscal(String, Int32, Int32)
Devolve o número de períodos relativos a um determinado ano Fiscal.
Declaration
int DaNumeroPeriodosMesFiscal(string Periodo, int Ano, int MesFiscal = 0)
Parameters
Type | Name | Description |
---|---|---|
System.String | Periodo | Identificador do período. |
System.Int32 | Ano | para o qual o período é válido. |
System.Int32 | MesFiscal |
Returns
Type | Description |
---|---|
System.Int32 |
DaNumUltimoPeriodo(String, Int32)
Devolve o número do último período relativo a um determinado ano Fiscal.
Declaration
int DaNumUltimoPeriodo(string Periodo, int Ano)
Parameters
Type | Name | Description |
---|---|---|
System.String | Periodo | Identificador do período. |
System.Int32 | Ano | Ano a pesquisar. |
Returns
Type | Description |
---|---|
System.Int32 |
DaPrimeiroPeriodoMesFiscal(String, Int32, Int32)
Devolve o primeiro período relativo a um determinado ano Fiscal.
Declaration
int DaPrimeiroPeriodoMesFiscal(string Periodo, int Ano, int MesFiscal = 0)
Parameters
Type | Name | Description |
---|---|---|
System.String | Periodo | Identificador do período. |
System.Int32 | Ano | para o qual o período é válido. |
System.Int32 | MesFiscal | Mês Fiscal a pesquisar. |
Returns
Type | Description |
---|---|
System.Int32 |
DaUltimoPeriodoMesFiscal(String, Int32, Int32)
Devolve o último período relativo a um determinado ano Fiscal.
Declaration
int DaUltimoPeriodoMesFiscal(string Periodo, int Ano, int MesFiscal = 0)
Parameters
Type | Name | Description |
---|---|---|
System.String | Periodo | Identificador do período. |
System.Int32 | Ano | para o qual o período é válido. |
System.Int32 | MesFiscal | Mês Fiscal a pesquisar. |
Returns
Type | Description |
---|---|
System.Int32 |
DaValorAtributo(String, String)
Devolve o valor de um atributo.
Declaration
object DaValorAtributo(string Periodo, string Atributo)
Parameters
Type | Name | Description |
---|---|---|
System.String | Periodo | Identificador do período. |
System.String | Atributo | Nome do atributo cujo valor será devolvido. |
Returns
Type | Description |
---|---|
System.Object |
DaValorAtributoLock(String, String)
Devolve o valor de um atributo, respeitando os locks da base de dados.
Declaration
object DaValorAtributoLock(string Periodo, string Atributo)
Parameters
Type | Name | Description |
---|---|---|
System.String | Periodo | Identificador do período. |
System.String | Atributo | Nome do atributo cujo valor será devolvido. |
Returns
Type | Description |
---|---|
System.Object |
DaValorAtributos(String, String[])
Devolve o valor de um conjunto de atributos.
Declaration
StdBECampos DaValorAtributos(string Periodo, params string[] Atributos)
Parameters
Type | Name | Description |
---|---|---|
System.String | Periodo | Identificador do período. |
System.String[] | Atributos | Conjunto de atributos dos quais se pretende devolver o valor. |
Returns
Type | Description |
---|---|
StdBECampos |
DaValorAtributosLock(String, String[])
Devolve o valor de um conjunto de atributos, respeitando os locks da base de dados.
Declaration
StdBECampos DaValorAtributosLock(string Periodo, params string[] Atributos)
Parameters
Type | Name | Description |
---|---|---|
System.String | Periodo | Identificador do período. |
System.String[] | Atributos | Conjunto de atributos dos quais se pretende devolver o valor. |
Returns
Type | Description |
---|---|
StdBECampos |
Edita(String, Int32)
Edita a informação de um período de processamento.
Declaration
RhpBEPeriodo Edita(string Periodo, int Ano)
Parameters
Type | Name | Description |
---|---|---|
System.String | Periodo | Identificador do período. |
System.Int32 | Ano | Ano para o qual o período é válido. |
Returns
Type | Description |
---|---|
RhpBEPeriodo |
EditaPeriodoEspecifico(String, Int32, Int32)
Efectua a edição de um Período específico.
Declaration
RhpBELinhaPeriodo EditaPeriodoEspecifico(string Periodo, int NumLinhaPeriodo, int Ano)
Parameters
Type | Name | Description |
---|---|---|
System.String | Periodo | |
System.Int32 | NumLinhaPeriodo | |
System.Int32 | Ano |
Returns
Type | Description |
---|---|
RhpBELinhaPeriodo |
Existe(String)
Verifica se existe o registo referente à informação passada nos parâmetros.
Declaration
bool Existe(string Periodo)
Parameters
Type | Name | Description |
---|---|---|
System.String | Periodo | Identificador do período. |
Returns
Type | Description |
---|---|
System.Boolean |
ExisteLinhaPerDetalhadoProc(String, Int32, Int32)
Verifica se existe o registo referente à informação passada nos parâmetros está processado.
Declaration
bool ExisteLinhaPerDetalhadoProc(string Periodo, int Ano, int NumPeriodo)
Parameters
Type | Name | Description |
---|---|---|
System.String | Periodo | Identificador do período. |
System.Int32 | Ano | Ano do período seleccionado como parametro. |
System.Int32 | NumPeriodo | Número do período seleccionado como parametro. |
Returns
Type | Description |
---|---|
System.Boolean |
ExistePerDetalhadoProc(String, Int32)
Verifica se existe o registo referente à informação passada nos parâmetros está processado.
Declaration
bool ExistePerDetalhadoProc(string Periodo, int Ano)
Parameters
Type | Name | Description |
---|---|---|
System.String | Periodo | Identificador do período. |
System.Int32 | Ano | Ano do período seleccionado como parametro. |
Returns
Type | Description |
---|---|
System.Boolean |
ExistePeriodoEspecifico(String, Int32, Int32)
Devolve a indicação da existência de um determinado período.
Declaration
bool ExistePeriodoEspecifico(string Periodo, int Ano, int NumLinhaPeriodo)
Parameters
Type | Name | Description |
---|---|---|
System.String | Periodo | Identificador do período. |
System.Int32 | Ano | para o qual o período é válido. |
System.Int32 | NumLinhaPeriodo | Número do período a pesquisar. |
Returns
Type | Description |
---|---|
System.Boolean |
LstAnosDoPeriodo(String)
Devolve os anos de um determinado período.
Declaration
StdBELista LstAnosDoPeriodo(string Periodo)
Parameters
Type | Name | Description |
---|---|---|
System.String | Periodo | Identificador do período. |
Returns
Type | Description |
---|---|
StdBELista |
LstPeriodos()
Devolve uma listagem de períodos de processamento.
Declaration
StdBELista LstPeriodos()
Returns
Type | Description |
---|---|
StdBELista |
LstPeriodosDoAno(String, Int32)
Devolve uma listagem de períodos de processamento para determinado tipo de período e ano.
Declaration
StdBELista LstPeriodosDoAno(string Periodo, int Ano)
Parameters
Type | Name | Description |
---|---|---|
System.String | Periodo | Identificador do período. |
System.Int32 | Ano | Ano pretendido para o período. |
Returns
Type | Description |
---|---|
StdBELista |
PeriodoTemDetalhes(String)
Devolve a indicação da existência de detalhes no período.
Declaration
bool PeriodoTemDetalhes(string Periodo)
Parameters
Type | Name | Description |
---|---|---|
System.String | Periodo | Identificador do período. |
Returns
Type | Description |
---|---|
System.Boolean |
PeriodoTemDetalhesAno(String, Int32)
Devolve a indicação da existência de detalhes no ano do período.
Declaration
bool PeriodoTemDetalhesAno(string Periodo, int Ano)
Parameters
Type | Name | Description |
---|---|---|
System.String | Periodo | Identificador do período. |
System.Int32 | Ano | para o qual o período é válido. |
Returns
Type | Description |
---|---|
System.Boolean |
Remove(String, Int32)
Remove a informação de um período de processamento.
Declaration
void Remove(string Periodo, int Ano)
Parameters
Type | Name | Description |
---|---|---|
System.String | Periodo | Identificador do período. |
System.Int32 | Ano | Ano para o qual o período é válido. |
ValidaActualizacao(RhpBEPeriodo, ref String)
Efectua a validação dos dados de períodos de processamento.
Declaration
bool ValidaActualizacao(RhpBEPeriodo ObjPeriodo, ref string ErroValidacao)
Parameters
Type | Name | Description |
---|---|---|
RhpBEPeriodo | ObjPeriodo | Objecto contendo os novos valores a actualizar. |
System.String | ErroValidacao | Recebe a descrição de eventuais erros detectados. |
Returns
Type | Description |
---|---|
System.Boolean |
ValidaRemocao(String, Int32, ref String)
Efectua a validação de um registo antes de ser efectuada a sua remoção.
Declaration
bool ValidaRemocao(string Periodo, int Ano, ref string ErroValidacao)
Parameters
Type | Name | Description |
---|---|---|
System.String | Periodo | Identificador do período. |
System.Int32 | Ano | Identificador do ano do período. |
System.String | ErroValidacao | Recebe a descrição de eventuais erros detectados. |
Returns
Type | Description |
---|---|
System.Boolean |
VerificaSeDataPertenceAoIntervaloPeriodo(String, Int32, Int32, DateTime)
Efectua a verificação da data pertencer ao Intervalo do período.
Declaration
bool VerificaSeDataPertenceAoIntervaloPeriodo(string Periodo, int Ano, int NumPeriodo, DateTime Data)
Parameters
Type | Name | Description |
---|---|---|
System.String | Periodo | Identificador do período. |
System.Int32 | Ano | para o qual o período é válido. |
System.Int32 | NumPeriodo | Número do período. |
System.DateTime | Data | Data a pesquisar. |
Returns
Type | Description |
---|---|
System.Boolean |