Tempo aproximado para leitura: 2 minutostotvs.framework.schedule.information
Classe que disponibiliza métodos para consultar informações sobre os agendamentos e tarefas cadastrados pelo modelo novo (Smart Schedule) ou antigo.
Namespace
totvs.framework.schedule
Disponível a partir da lib 20250224.
Métodos
New()
Instancia da classe (construtor).
Exemplo de uso:
|
getSchedulesByRoutine()
Retorna uma lista de agendamentos de determinada rotina.
Parâmetros:
Nome | Tipo | Obrigatório | Default | Descrição |
|---|---|---|---|---|
| cRoutine | Caractere | X | Nome da rotina/função | |
| cFil | Caractere | Filial do agendamento | ||
| cStatus | Caractere | Status do agendamento |
Retorno:
aSchedules, array, lista com os agendamentos encontrados para a rotina enviada.
Posição x-1: objeto com informações do cadastro do agendamento
Posição x-2: objeto com informações dos parâmetros do agendamento
Exemplo de uso:
|
Sintaxe: oScheduleInfo:getSchedulesByRoutine() → Array
getIdSchedulesByRoutine()
Retorna os IDs dos agendamentos de determinada rotina.
Parâmetros:
Nome | Tipo | Obrigatório | Default | Descrição |
|---|---|---|---|---|
| cRoutine | Caractere | X | Nome da rotina/função | |
| cFil | Caractere | Filial do agendamento | ||
| cStatus | Caractere | Status do agendamento |
Retorno:
aSchedules, array, lista com os ids dos agendamentos.
Exemplo de uso:
|
Sintaxe: oScheduleInfo:getIdSchedulesByRoutine() → Array
getScheduleById()
Retorna um agendamento de acordo com o id enviado.
Parâmetros:
Nome | Tipo | Obrigatório | Default | Descrição |
|---|---|---|---|---|
| cId | Caractere | X | Código do agendamento | |
| cFil | Caractere | Filial do agendamento | ||
| cStatus | Caractere | Status do agendamento |
Retorno:
aSchedule, array, lista com as informações do agendamento.
Posição 1: objeto com informações de cadastro do agendamento
Posição 2: objeto com os parâmetros do agendamento
Exemplo de uso:
|
Sintaxe: oScheduleInfo:getScheduleById() → Array
getIdTasksByRoutine()
Retorna os IDs das tarefas de determinada rotina.
Parâmetros:
Nome | Tipo | Obrigatório | Default | Descrição |
|---|---|---|---|---|
| cRoutine | Caractere | X | Nome da rotina/função | |
| cEmp | Caractere | Empresa | ||
| cFil | Caractere | Filial | ||
| cStatus | Caractere | Status |
Retorno:
aTasks, array, lista com os ids das tarefas.
Exemplo de uso:
|
Sintaxe: oScheduleInfo:getIdTasksByRoutine() → Array
getTaskById()
Retorna uma tarefa de acordo com o id enviado.
Parâmetros:
Nome | Tipo | Obrigatório | Default | Descrição |
|---|---|---|---|---|
| cCodigo | Caractere | X | Código do agendamento (pode ser vazio para as tarefas criadas pela função createTask()) | |
| cItem | Caractere | X | Código da tarefa | |
| cFil | Caractere | Filial | ||
| cStatus | Caractere | Status |
Retorno:
oTask, object, objeto com as informações da tarefa.
Exemplo de uso:
|
Sintaxe: oScheduleInfo:getTaskById() → Object
getSmartScheduleIsRunning()
Retorna se o Smart Schedule está em execução no ambiente corrente.
Retorno:
lRet, logical, .T. ou .F.
Exemplo de uso:
|
Sintaxe: oScheduleInfo:getSmartScheduleIsRunning() → Logical
getOldScheduleIsRunning()
Retorna se o Schedule (antigo) está em execução no ambiente corrente.
Retorno:
lRet, logical, .T. ou .F.
Exemplo de uso:
|
Sintaxe: oScheduleInfo:getOldScheduleIsRunning() → Logical
getEnvironmentsScheduleRunning()
Retorna os ambientes que estão com o schedule em execução.
Parâmetros:
Nome | Tipo | Obrigatório | Default | Descrição |
|---|---|---|---|---|
| nType | Numeric | X | Tipo do motor (1 para antigo e 2 para smart) | |
| cEnvironment | Caractere | Ambiente que deseja verificar a execução. Se não for enviado, o método retornará todos os ambientes em execução. Se for enviado, o método retornará uma lista de uma posição em caso positivo ou uma lista vazia em caso negativo. |
Retorno:
aEnvironments, array, lista com os nomes dos ambientes.
Exemplo de uso:
|
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas