@seniorsistemas/hcm-clocking-event-rule-nodejs 0.35.0

package/README.doc.md

@@ -0,0 +1,658 @@
+# Biblioteca de Regras de Apuração de Eventos de Ponto
+
+Esta biblioteca é uma implementação em Node.js para a criação de regras de apuração de eventos de ponto, permitindo a personalização do processamento de eventos de ponto e apurações de horas trabalhadas.
+A biblioteca é projetada para ser utilizada em ambientes como AWS Lambda, onde você pode receber eventos de ponto e processá-los de acordo com regras personalizadas.
+
+
+## Dicas de como usar a biblioteca
+
+Tudo começa pelo contexto [Context](./classes/Context.html), que é a base para a execução das regras de apuração. O contexto contém informações sobre o dados recebido para serem customizados, 
+como: contratos, colaboradores, apurações, históricos, programações entre outros.
+
+Com o contexto carregado, você pode acessar os contratos dos colaboradores, e iterar sobre as apurações de cada contrato. A partir daí, você pode implementar suas regras personalizadas para processar as apurações.
+
+As informações sobre os contratos e colaboradores estão disponíveis através da classe [Contract](./classes/Contract.html), que contém métodos para consultar informações do colaborador, históricos, programações, banco de horas, entre outros. Vai encontrar informações de todos as apurações do colaborador, sem contextualização de data, ou seja, todas os históricos e programações do colaborador estão disponíveis sem contexto de dia, permitindo que você acesse dados históricos e programações que podem não ter sido aplicada em um dia, como afastamentos em dias de DSR.
+
+As informações sobre as apurações estão disponíveis através da classe [TimeEvaluation](./classes/TimeEvaluation.html), que contém métodos para manipular e validar as apurações. Na apuração, 
+você pode acessar informações como situações, marcações, horários, escalas, feriados e outros dados relevantes para a lógica de negócio. Os históricos e programações também estão disponíveis para 
+consulta e manipulação, sem a necessidade de filtrar quais são os históricos ou programações associados a apuração do dia atual, pois a biblioteca já faz isso para você.
+
+A alteração de situações é feita através do objeto [TimeEvaluation](./classes/TimeEvaluation.html), nele é disponibilizado métodos como  `setSituationHour`, `sumSituationHour`, 
+`resetSituationHour`, entre outros, que permitem modificar as situações conforme a lógica de negócio definida. Todas as situações que são referências nas definições de situações históricos ou 
+programações são carregadas no contexto, com informações completas como código, tipo e situação complementar, caso a regra adicione uma situação que não esteja definida no contexto, a biblioteca 
+irá aceitar a situação, mas não disponibilizará informações adicionais sobre ela, como tipo e situação complementar. Sendo o consultor responsável por estas informações.
+
+
+## Saídas da regra
+
+A regra permite fazer as seguintes alterações, como:
+ - Modificar as situações.
+ - Invalidar a apuração para não ser calculada.
+ - Customizar a geração de pendências de acerto.
+ - Gerar logs personalizados, do tipo `logInfo`, `logError`, `logWarning`.
+
+
+## Desenvolvimento
+
+### Utilização em labdas AWS
+
+Para utilizar a biblioteca, importe os módulos necessários no seu projeto Node.js/Javascript. Por exemplo, uma versão inicial da lambda:
+
+Arquivo: `package.json`, deve ser adicionado o exemplo abaixo e substituir a dependência `hcm-clocking-event-rule-nodejs` pela última versão disponível no [npm](https://www.npmjs.com/package/hcm-clocking-event-rule-nodejs).
+
+```json
+{
+    "name": "k02fEIVHGoYutimeEvaluationRulePoint",
+    "version": "1.0.0",
+    "description": "",
+    "main": "index.js",
+    "scripts": {
+        "test": ""
+    },
+    "dependencies": {
+        "hcm-clocking-event-rule-nodejs":"1.0.0"
+    },
+    "author": "",
+    "license": ""
+}
+```
+
+
+Arquivo: `index.js`, arquivo inicial da lambda, deve ser criado na raiz do projeto e conter o seguinte código:
+
+```javascript
+const { Context } = require('hcm-clocking-event-rule-nodejs');
+const { TimeEvaluationRule } = require('./rule/TimeEvaluationRule');
+
+
+exports.handler = async(event) => {
+    return sendRes(200, event);
+};
+
+const sendRes = (status, event) => {
+  
+  let context = new Context(event);
+  try{
+     const evaluationService = new TimeEvaluationRule(context);
+     evaluationService.execute();
+  } catch(error) {
+     context.logError(`Erro: ${error.message}, stack: ${error.stack}`);
+  }
+
+  const body = context.getBodyResult();
+  
+  var response = {
+    statusCode: status,
+    headers: {
+      "Content-Type": "application/json"
+    },
+    body: body
+  };
+
+  return response;
+};
+```
+
+Arquivo: `TimeEvaluationRule.js`, deve ser criado na rule do projeto e conter o seguinte código, exemplo de uma regra de apuração:
+
+```javascript
+const { DateUtils, DateIntervalUtils, DateInterval } = require('hcm-clocking-event-rule-nodejs');
+
+class TimeEvaluationRule {
+   constructor(context) {
+    this.context = context;
+   }
+
+   execute() {
+    try{
+      //Iterar sobre os contratos do contexto e executar alguma lógica
+      this.context.contracts.forEach((contract) => {
+        //Iterar sobre as apurações do contrato do colaborador
+        contract.timeEvaluation.forEach((timeEvaluation) => {
+        try{
+            this.timeEvaluation(timeEvaluation, contract); 
+        } catch(error) {
+            timeEvaluation.invalidate(`Erro: ${error.message}, stack: ${error.stack}`);
+        }
+             
+        });
+      });
+    } catch(error) {
+        this.context.logError(`Erro: ${error.message}, stack: ${error.stack}`);
+    } 
+   }
+
+    /**
+    * Método para processar as apurações.
+    * @param {TimeEvaluation} timeEvaluation - Apuração
+    * @param {Contract} contract - O contrato do colaborador
+    */
+   timeEvaluation(timeEvaluation, contract){
+        // Implementar a lógica de customização....
+   }
+
+}
+
+module.exports = { TimeEvaluationRule };
+```
+
+Arquivo de test: `test.js`, deve ser criado na pasta `test` do projeto e conter o seguinte código, exemplo de um teste unitário:
+
+```javascript
+const { handler } = require('../index');  // Certifique-se de que o caminho está correto
+
+const event = {
+  body: '' // aqui será adicionado o contexto de regra.
+};
+
+handler(event).then(response => {
+  console.log("Response:", response);
+}).catch(err => {
+  console.error("Error:", err);
+});
+```
+
+
+### Ambiente Local para desenvolvimento (Opcional)
+
+#### Criando um servidor local para testes
+
+1. Criar uma pasta para o projeto e inicializar um projeto Node.js:
+
+```bash
+mkdir regras-local
+cd regras-local
+npm init -y
+```
+
+2. Alterar o arquivo `package.json` para incluir a dependência da biblioteca e configurações:
+
+```json
+{
+  "name": "regras-local",
+  "version": "1.0.0",
+  "description": "",
+  "main": "src/server.js",
+  "scripts": {
+    "start": "node src/server.js",
+    "dev": "nodemon"
+  },
+  "dependencies": {
+    "circular-json": "^0.5.9",
+    "cross-env": "^7.0.3",
+    "express": "^4.21.2",
+    "hcm-clocking-event-rule-nodejs":"0.22.0"
+  },
+  "devDependencies": {
+    "nodemon": "^3.1.10"
+  }
+}
+```
+
+3. Criar um arquivo na pasta raiz com o nome `nodemon.json` e adicionar o seguinte código:
+
+```json
+{
+    "watch": ["src"],
+    "ext": "js,json",
+    "ignore": ["node_modules"],
+    "exec": "cross-env TZ=UTC node src/server.js"
+}
+```
+
+4. Criar a pasta `src` e dentro dela criar o arquivo `server.js` com o seguinte conteúdo:
+
+```javascript
+const express = require('express');
+const { Context, IntervalTypes, DateUtils } = require('hcm-clocking-event-rule-nodejs');
+
+const app = express();
+app.use(express.json());
+const port = process.env.PORT || 3000;
+
+// Iniciar o servidor Express
+app.listen(port,() => {
+    console.log(`Servidor rodando em http://localhost:${port}`);
+});
+
+// Endpoint para chamar o handler como se fosse AWS Lambda
+app.post('/rule', async(req, res) => {
+    try {
+        const event = { body: req.body };
+        const result = await exports.handler(event);
+        res.status(result.statusCode).json(JSON.parse(result.body));
+    } catch(err) {
+        res.status(500).json({ error: err.message });
+    }
+});
+
+// Handler para AWS Lambda
+exports.handler = async(event) => {
+    // O AWS Lambda recebe o body como string
+    const body = typeof event.body === 'string' ? JSON.parse(event.body) : event.body;
+    const context = new Context({ body: JSON.stringify(body) });
+
+    executeRule(context);
+    const changes = context.getBodyResult();
+    return {
+        statusCode: 200,
+        body: changes,
+    };
+};
+
+/**
+ * Função para executar a regra de apuração. Substitua a lógica de negócio
+ * conforme necessário.
+ * @param {Context} context - O contexto com os dados de apuração.
+ * */
+function executeRule(context) {
+    context.contracts.forEach((contract) => {
+        contract.timeEvaluation.forEach((timeEvaluation) => {
+            timeEvaluation.timeEvaluationSituations.forEach((timeEvaluationSituation) => {
+                // implementar a lógica de customização....
+            });
+        });
+    });
+}
+```
+
+5. Instalar os pacotes necessários:
+
+```bash
+npm install
+```
+
+6. Rodar o servidor local para testes:
+
+```bash
+npm run dev
+```
+Após executar o comando acima, o servidor estará rodando em `http://localhost:3000`. Exemplo de saída do terminal:
+
+```
+PS C:\regras-local> npm run dev 
+
+> regras-local@1.0.0 dev
+> nodemon
+
+[nodemon] 3.1.10
+[nodemon] to restart at any time, enter `rs`
+[nodemon] watching path(s): src\**\*
+[nodemon] watching extensions: js,json
+[nodemon] starting `cross-env TZ=UTC node src/server.js`
+Servidor rodando em http://localhost:3000
+```
+
+
+7. Acesse o servidor local em `http://localhost:3000/rule` e envie um POST com o corpo contendo os dados de apuração que deseja processar. Para obter o json com o dados da apuração acesse a tela de acerto com permissão de desenvolvedor, no dia clique em ações na opção de exportar entrada de regra.
+
+Sugestão utilizar um aplicativo como o [Postman](https://www.postman.com/) ou [Insomnia](https://insomnia.rest/) para enviar requisições POST com o corpo JSON ou fazer via linha de comando com `curl`, substituindo o parâmetro data-raw pelo json que deseja enviar:
+
+```bash
+curl --location 'http://localhost:3000/rule' --header 'Content-Type: application/json' --data-raw '{
+    "version": "1.0.0",
+    "input": {...}}'
+```
+
+
+#### Depuração em VS Code
+
+Caso desejar depurar o código da regra diretamente no Visual Studio Code (VS Code) para facilitar o desenvolvimento e testes, você precisará configurar o ambiente de depuração.
+
+Siga estes passos:
+
+1. No VS Code, clique em "Run and Debug" (ícone de play com inseto na barra lateral) ou pressione Ctrl+Shift+D.
+2. Clique em "create a launch.json file" se ainda não existir.
+3. Escolha "Node.js" como ambiente.
+4. No arquivo `launch.json`, adicione a configuração para rodar seu arquivo:
+
+```json
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "pwa-node",
+            "request": "launch",
+            "name": "Debug server.js",
+            "program": "${workspaceFolder}/src/server.js",
+            "env": {
+                "PORT": "3000"
+            }
+        }
+    ]
+}
+```
+5. Salve o arquivo e clique em "Start Debugging" (F5).
+
+
+## Limitações
+
+A regra trabalha somente considerando os dias apurados, ou seja, informações sobre dias que não foram apurados não estão disponíveis no contexto. Isso significa que a biblioteca não pode acessar dados de dias futuros ou passados que não foram processados.
+A biblioteca é projetada para ser utilizada em ambientes de execução como AWS Lambda, e possui algumas limitações:
+ - Não é possível acessar diretamente o banco de dados, pois a biblioteca não possui suporte para manipulação direta de banco de dados.
+ - Leitura de campos e entidades customizadas.
+ - Buscar dados que não estão carregados no contexto, como por exemplo, buscar dados de um banco de dados externo ou períodos que não foram calculados.
+ - Informações sobre usuário, papéis, permissões e abrangência.
+ - Manipulação de banco de dados.
+
+
+## Comparação entre XT e X
+
+<table>
+  <thead>
+    <tr>
+      <th style="width: 20%;">Função</th>
+      <th style="width: 40%;">Gestão do Ponto XT</th>
+      <th style="width: 40%;">Gestão do Ponto X</th>
+    </tr>
+  </thead>
+ <tbody>
+    <tr>
+      <td>Retorna o dia da semana da data passada</td>
+      <td><code>int getDiaSem(LocalDate data)</code></td>
+      <td><code>DateUtils.getWeekDay(dataRef): string</code></td>
+    </tr>
+    <tr>
+      <td>Retorna o dia da data passada</td>
+      <td><code>int getDiaData(LocalDate data)</code></td>
+      <td><code>DateUtils.getDay(dataRef): number</code></td>
+    </tr>
+    <tr>
+      <td>Retorna o mês da data passada</td>
+      <td><code>int getMesData(LocalDate data)</code></td>
+      <td><code>DateUtils.getMonth(dataRef): number</code></td>
+    </tr>
+    <tr>
+      <td>Retorna o ano da data passada</td>
+      <td><code>int getAnoData(LocalDate data)</code></td>
+      <td><code>DateUtils.getYear(dataRef): number</code></td>
+    </tr>
+    <tr>
+      <td>Retorna a quantidade de dias em um determinado mês</td>
+      <td><code>int getQtdDiasMes(LocalDate data)</code></td>
+      <td><code>DateUtils.getNumberOfDaysInMonth(dataRef): number</code></td>
+    </tr>
+    <tr>
+      <td>Retorna a última data em um determinado mês</td>
+      <td><code>LocalDate getUltimoDiaMes(LocalDate data)</code></td>
+      <td><code>DateUtils.getLastDayOfMonth(dataRef): Date</code></td>
+    </tr>
+    <tr>
+      <td>Retorna o usuário corrente</td>
+      <td><code>long getUsuarioAtivo()</code></td>
+      <td><code>context.currentUser: User</code></td>
+    </tr>
+    <tr>
+      <td>Retorna as contas dos bancos de horas que o colaborador possui na data</td>
+      <td><code>List&lt;IContaBH&gt; buscaContas(int numEmp, int tipCol, int numCad, LocalDate data)</code></td>
+      <td>
+        <code>contract.hourBankAccounts: HourBankAccount[]</code> ou<br>
+        <code>timeEvaluation.hourBankAccounts: HourBankAccount[]</code>
+      </td>
+    </tr>
+    <tr>
+      <td>Retorna o colaborador</td>
+      <td><code>IColaboradorPonto getColaborador(int empresa, int tipo, int cadastro)</code></td>
+      <td><code>contract.employee: Employee</code></td>
+    </tr>
+    <tr>
+      <td>Retorna a data inicial do processamento do cálculo</td>
+      <td><code>LocalDate getDataInicial()</code></td>
+      <td><code>context.startDate: Date</code></td>
+    </tr>
+    <tr>
+      <td>Retorna a data final do processamento do cálculo</td>
+      <td><code>LocalDate getDataFinal()</code></td>
+      <td><code>context.endDate: Date</code></td>
+    </tr>
+    <tr>
+      <td>Retorna uma lista de históricos de afastamento na apuração</td>
+      <td><code>List&lt;HistoricoAfastamento&gt; getHistoricosAfastamento()</code></td>
+      <td><code>timeEvaluation.leaveHistories: LeaveHistory[]</code></td>
+    </tr>
+    <tr>
+      <td>Retorna o histórico de apuração do colaborador na apuração</td>
+      <td><code>HistoricoApuracao getHistoricoApuracao()</code></td>
+      <td><code>timeEvaluation.timeEvaluationHistory: TimeEvaluationHistory</code></td>
+    </tr>
+    <tr>
+      <td>Retorna o histórico do cargo do colaborador na apuração</td>
+      <td><code>HistoricoCargo getHistoricoCargo()</code></td>
+      <td><code>timeEvaluation.jobPositionHistory: JobPositionHistory</code></td>
+    </tr>
+    <tr>
+      <td>Retorna o histórico do centro de custo do colaborador na apuração</td>
+      <td><code>HistoricoCentroCusto getHistoricoCentrodeCusto()</code></td>
+      <td><code>timeEvaluation.costCenter: CostCenter</code></td>
+    </tr>
+    <tr>
+      <td>Retorna o histórico de escala do colaborador na apuração</td>
+      <td><code>HistoricoEscala getHistoricoEscala()</code></td>
+      <td><code>timeEvaluation.workshiftHistory: WorkshiftHistory</code></td>
+    </tr>
+    <tr>
+      <td>Retorna o histórico de filial do colaborador na apuração</td>
+      <td><code>HistoricoFilial getHistoricoFilial()</code></td>
+      <td><code>timeEvaluation.companyBranchHistory: CompanyBranchHistory</code></td>
+    </tr>
+    <tr>
+      <td>Retorna o histórico do sindicato do colaborador na apuração</td>
+      <td><code>HistoricoSindicato getHistoricoSindicato()</code></td>
+      <td><code>timeEvaluation.syndicate: Syndicate</code></td>
+    </tr>
+    <tr>
+      <td>Retorna o histórico de vínculo do colaborador na apuração</td>
+      <td><code>HistoricoVinculo getHistoricoVinculo()</code></td>
+      <td><code>timeEvaluation.employmentRelationshipHistory: EmploymentRelationshipHistory</code></td>
+    </tr>
+    <tr>
+      <td>Retorna uma lista de autorização de horas extras do colaborador na apuração</td>
+      <td><code>List&lt;AutorizacaoHorasExtras&lt; getAutorizacoesHorasExtras()</code></td>
+      <td><code>timeEvaluation.overtimeAuthorizations: OvertimeAuthorization[]</code></td>
+    </tr>   
+      <tr>
+      <td>Retorna a programação de ponte do colaborador na apuração</td>
+      <td><code>Ponte getPonte()</code></td>
+      <td><code>timeEvaluation.bridge: Bridge</code></td>
+    </tr> 
+    <tr>
+      <td>Retorna uma lista de sobreaviso do colaborador na apuração</td>
+      <td><code>List&lt;SobreavisoProntidao&lt; getSobreaviso()</code></td>
+      <td><code>timeEvaluation.readinesses: Readiness[]</code></td>
+    </tr>
+    <tr>
+      <td>Retorna o feriado na data</td>
+      <td><code>Feriado getFeriado(LocalDate data)</code></td>
+      <td>
+        <code>timeEvaluation.holiday: Holiday</code> ou <br>
+        <code>contract.getHolidayByDate(date): Holiday</code>
+      </td>
+    </tr> 
+    <tr>
+      <td>Retorna o horário na apuração</td>
+      <td><code>Horario getHorario()</code></td>
+      <td><code>timeEvaluation.workschedule: Workschedule</code></td>
+    </tr> 
+    <tr>
+      <td>Retorna a escala na apuração</td>
+      <td><code>Escala getEscala()</code></td>
+      <td><code>	timeEvaluation.workshift: Workshift</code></td>
+    </tr> 
+    <tr>
+      <td>Retorna uma lista com as marcações realizadas</td>
+      <td><code>List&lt;MarcacaoRegra&lt; getMarcacoesRealizadas(boolean isConsiderarGeradas)</code></td>
+      <td><code>timeEvaluation.getClockingEvents(true): ClockingEvent[]</code></td>
+    </tr> 
+    <tr>
+      <td>Retorna o total de minutos apurados em determinada situação</td>
+      <td><code>int getHorSit(int codSit)</code></td>
+      <td><code>timeEvaluation.getSituationHour(situationCode): number</code></td>
+    </tr> 
+    <tr>
+      <td>Retorna o total de minutos apurados em um range de situações</td>
+      <td><code>int getHorSitFaixa(int sitIni, int sitFim)</code></td>
+      <td><code>timeEvaluation.getSituationHourByRange(startCode, endCode): number</code></td>
+    </tr> 
+    <tr>
+      <td>Retorna o total de minutos apurados em um grupo de situações</td>
+      <td><code>int getHorSit(int... codSit)</code></td>
+      <td><code>timeEvaluation.getSituationHourByCodes(15, 16): number</code></td>
+    </tr> 
+    <tr>
+      <td>Retorna o código do horário conforme a escala</td>
+      <td><code>int getHorarioEscala()</code></td>
+      <td><code>timeEvaluation.workscheduleWorkshift: Workschedule</code></td>
+    </tr>
+    <tr>
+      <td>Retorna a programação de troca de escala</td>
+      <td><code>int getTrocaEscala(LocalDate data)</code></td>
+      <td><code>timeEvaluation.workshiftChange: WorkshiftChange</code></td>
+    </tr>
+    <tr>
+      <td>Retorna a programação de troca de horário</td>
+      <td><code>int getTrocaHorario(LocalDate data)</code></td>
+      <td><code>timeEvaluation.workscheduleChange: WorkscheduleChange</code></td>
+    </tr>
+    <tr>
+      <td>Retorna a previsão de horas de trabalho</td>
+      <td><code>ISeparacaoHoras getHorasPrevistas(int codigoHorario)</code></td>
+      <td><code>timeEvaluation.estimatedHours.work: SeparatedHours[]</code></td>
+    </tr>
+    <tr>
+      <td>Retorna a previsão de horas de refeição</td>
+      <td><code>ISeparacaoHoras getRefeicaoPrevista()</code></td>
+      <td><code>timeEvaluation.estimatedHours.meal: SeparatedHours[]</code></td>
+    </tr>
+    <tr>
+      <td>Retorna a previsão de horas de lanche</td>
+      <td><code>ISeparacaoHoras getLanchePrevisto(int parte)</code></td>
+      <td><code>timeEvaluation.estimatedHours.snack: SeparatedHours[]</code></td>
+    </tr>
+    <tr>
+      <td>Permite cancelar o processamento e mostrar mensagem</td>
+      <td><code>void mensagemLog(String mensagem)</code></td>
+      <td>
+        <code>context.logError(msg): void</code> ou <br/>
+        <code>timeEvaluation.invalidate(msg): void</code>
+      </td>
+    </tr>
+    <tr>
+      <td>Retorna horas extras diurnas</td>
+      <td><code>ISeparacaoHoras getExtrasIntervalo(int horIni, int horFim)</code></td>
+      <td><code>timeEvaluation.getOvertimeByRangeTime(360, 480): SeparatedHours</code></td>
+    </tr>
+    <tr>
+      <td>Soma uma quantidade de horas em determinada situação</td>
+      <td><code>void somaHorasSituacao(int codSit, int qtdeHoras)</code></td>
+      <td><code>timeEvaluation.sumSituationHour(situationCode, numberOfHours): void</code></td>
+    </tr>
+    <tr>
+      <td>Zera a quantidade de horas apuradas de uma determinada situação</td>
+      <td><code>void zeraHorasSituacao(int... codSit)</code></td>
+      <td>
+        <code>timeEvaluation.resetSituationHour(situationCode): void</code> ou <br/>
+        <code>timeEvaluation.resetSituationHourByCodes(situationCode[]): void</code>
+      </td>
+    </tr>
+    <tr>
+      <td>Zera a quantidade de horas apuradas de uma faixa de situações</td>
+      <td><code>void zeraHorasSituacaoFaixa(int sitIni, int sitFim)</code></td>
+      <td><code>timeEvaluation.resetSituationHourByRange(startCode, endCode): void</code></td>
+    </tr>
+    <tr>
+      <td>Altera a quantidade de horas apuradas</td>
+      <td><code>void setHorSit(int codSit, int horas)</code></td>
+      <td><code>timeEvaluation.setSituationHour(situationCode, numberOfHours): void</code></td>
+    </tr>
+    <tr>
+      <td>Retorna a quantidade de horas diurnas e noturnas de um tipo de intervalo</td>
+      <td><code>ISeparacaoHoras getHorasSeparadas(TipoIntervalo tipo)</code></td>
+      <td><code>timeEvaluation.getSeparateHours(intervalType, tolerance): SeparatedHours</code></td>
+    </tr>
+    <tr>
+      <td>Retorna a quantidade de horas diurnas e noturnas de um tipo de intervalo com tolerância</td>
+      <td><code>ISeparacaoHoras getHorasSeparadas(TipoIntervalo tipo, boolean consideraTolerancia)</code></td>
+      <td><code>timeEvaluation.getSeparateHours(intervalType, tolerance): SeparatedHours</code></td>
+    </tr>
+    <tr>
+      <td>Retorna a quantidade de horas diurnas e noturnas de um tipo de intervalo e expediente</td>
+      <td><code>ISeparacaoHoras getHorasSeparadas(TipoIntervalo tipo, int expediente)</code></td>
+      <td><code>timeEvaluation.getSeparateHoursWithExpedientPart(intervalType, part, tolerance): SeparatedHours</code></td>
+    </tr>
+    <tr>
+      <td>Retorna a quantidade de horas diurnas e noturnas de um tipo de intervalo e expediente com tolerância</td>
+      <td><code>ISeparacaoHoras getHorasSeparadas(TipoIntervalo tipo, int expediente, boolean consideraTolerancia)</code></td>
+      <td><code>timeEvaluation.getSeparateHoursWithExpedientPart(intervalType, part, tolerance): SeparatedHours</code></td>
+    </tr>
+    <tr>
+      <td>Retorna a quantidade de horas diurnas e noturnas de um subtipo de intervalo</td>
+      <td><code>ISeparacaoHoras getHorasSeparadas(SubTipoIntervalo subTipo)</code></td>
+      <td><code>timeEvaluation.getSeparateHoursIntervalSubType(intervalSubType, tolerance): SeparatedHours</code></td>
+    </tr>
+    <tr>
+      <td>Retorna a quantidade de horas diurnas e noturnas de um subtipo de intervalo com tolerância</td>
+      <td><code>ISeparacaoHoras getHorasSeparadas(SubTipoIntervalo subTipo, boolean consideraTolerancia)</code></td>
+      <td><code>timeEvaluation.getSeparateHoursIntervalSubType(intervalSubType, tolerance): SeparatedHours</code></td>
+    </tr>
+    <tr>
+      <td>Retorna a quantidade de horas diurnas e noturnas de um subtipo de intervalo e expediente</td>
+      <td><code>ISeparacaoHoras getHorasSeparadas(SubTipoIntervalo subTipo, int expediente)</code></td>
+      <td><code>timeEvaluation.getSeparateHoursIntervalSubTypeWithExpedientPart (intervalSubType, part, tolerance): SeparatedHours</code></td>
+    </tr>
+    <tr>
+      <td>Retorna a quantidade de horas diurnas e noturnas de um subtipo de intervalo e expediente com tolerância</td>
+      <td><code>ISeparacaoHoras getHorasSeparadas(SubTipoIntervalo subTipo, int expediente, boolean consideraTolerancia)</code></td>
+      <td><code>timeEvaluation.getSeparateHoursIntervalSubTypeWithExpedientPart (intervalSubType, part, tolerance): SeparatedHours</code></td>
+    </tr>
+    <tr>
+      <td>Permite modificar o indicador para gerar pendência no dia apurado</td>
+      <td><code>void setGerarPendenciaAcerto(boolean gerarPendencia)</code></td>
+      <td><code>timeEvaluation.generatePendingAdjustment(true): void</code></td>
+    </tr>
+    <tr>
+      <td>Retorna o indicador de que no dia apurado será gerada uma pendência</td>
+      <td><code>boolean isGerarPendenciaAcerto()</code></td>
+      <td><code>timeEvaluation.generatePendingAdjustment: boolean</code></td>
+    </tr>
+    <tr>
+      <td>Retorna o indicador de que o dia atual tem falta de marcação</td>
+      <td><code>boolean isFaltaMarcacao()</code></td>
+      <td><code>timeEvaluation.missingClockingEvent: boolean</code></td>
+    </tr>
+    <tr>
+      <td>Retorna a definição de situação que está sendo utilizada na apuração</td>
+      <td><code>DefinicoesSituacoes getDefinicaoSituacoes()</code></td>
+      <td><code>timeEvaluation.situationDefinition: TimeEvaluationSituationDefinitionHistory</code></td>
+    </tr>
+    <tr>
+      <td>Retorna a lista de compensações existente para o colaborador</td>
+      <td><code>List&lt;Compensacao&lt;> getCompensacoes()</code></td>
+      <td><code>timeEvaluation.: Compensation[]</code></td>
+    </tr>
+    <tr>
+      <td>Retorna uma lista de intervalos calculados na apuração</td>
+      <td><code>List&lt;IntervaloCalculo&lt; getIntervalosCalculados()</code></td>
+      <td>
+        <code>timeEvaluation.intervals: Interval[]</code> ou<br/>
+        <code>timeEvaluation.getCalculatedIntervalByType(intervalType): Interval[]</code> ou<br/>
+        <code>timeEvaluation.getCalculatedIntervalBySubType(intervalSubType): Interval[]</code>
+      </td>
+    </tr>
+    <tr>
+      <td>Retorna um determinado intervalo calculado na apuração indexado</td>
+      <td><code>IntervaloCalculo getIntervaloCalculado(int indice)</code></td>
+      <td><code>timeEvaluation.getCalculatedIntervalByIndex(index): Interval</code></td>
+    </tr>
+    <tr>
+      <td>Retorna a quantidade de horas trabalhadas no dia</td>
+      <td><code>ISeparacaoHoras getHorasTrabalhadas()</code></td>
+      <td><code>timeEvaluation.getSeparateHours(IntervalTypes.WORKING, true): SeparatedHours</code></td>
+    </tr>
+    <tr>
+      <td>Retorna a quantidade de minutos trabalhados em determinada parte do expediente</td>
+      <td><code>ISeparacaoHoras getHorasTrabalhadas(int parte)</code></td>
+      <td><code>timeEvaluation.getSeparateHoursWithExpedientPart (IntervalTypes.WORKING, part, tolerance): SeparatedHours</code></td>
+    </tr>
+  </tbody>
+</table>
+