OCRotaICalendarSNC - Global

A API OCRotaICalendarSNC fornece eventos no formato iCal para a rotação de um usuário específico.

OCRotaICalendarSNC - cleanExpiredCache ()

Registros na tabela cmn_rota_resp_cache que têm uma data Inicial anterior a hoje.

Tabela 1. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 2. Retorna

Tipo	Descrição
vazio

OCRotaICalendarSNC - createCalendarEvents (cadeia de caracteres groupId, cadeia de caracteres rotaId, cadeia de caracteres userId, objeto dateRangeObj)

Retorna a lista de AJAXScheduleItems para o plantão do usuário.

Tabela 3. Parâmetros

Nome	Tipo	Descrição
groupId	Cadeia de caracteres	O SYS ID do grupo.
rotaId	Cadeia de caracteres	O ID do sistema de rotação.
userId	Cadeia de caracteres	O SYS ID do usuário.
dateRangeObj	Objeto	Contém as datas iniciais e finais do conjunto de dados.

Tabela 4. Retorna

Tipo	Descrição
AJAXScheduleItem	Lista Java de AJAXScheduleItems.

OCRotaICalendarSNC - createCustomEvent (cadeia de caracteres groupName, objeto scheduleItemSpan, cadeia de caracteres calendarLink)

Cria um VEVENT com base no scheduleItemSpan fornecido.

Tabela 5. Parâmetros

Nome	Tipo	Descrição
groupName	Cadeia de caracteres	Nome do grupo de plantão.
scheduleItemSpan	Objeto	Período de tempo para o período de plantão.
calendarLink	Cadeia de caracteres	Um link de volta para o calendário de plantão na instância.

Tabela 6. Retorna

Tipo	Descrição
Cadeia de caracteres	Um VEVENT com base no scheduleItemSpan fornecido.

OCRotaICalendarSNC - createPlaceholderCalendar (GlideRecord rotaGR, Objeto dateRangeObj, Cadeia de caracteres calendarLink)

Cria um iCalendar formatado se o usuário não tiver nenhum plantão próximo.

Tabela 7. Parâmetros

Nome	Tipo	Descrição
rotaGR	GlideRecord	O registro do glide cmn_rota.
dateRangeObj	Objeto	Contém as datas iniciais e finais do conjunto de dados.
calendarLink	Cadeia de caracteres	Um link para o calendário de plantão deste usuário.

Tabela 8. Retorna

Tipo	Descrição
Cadeia de caracteres	iCalendar formatado com um espaço reservado VEVENT.

OCRotaICalendarSNC - getCalendarEvents (cadeia de caracteres groupId , cadeia de caracteres rotaId, cadeia de caracteres userId , objeto dateRangeObj, booliano useCache)

Retorna o iCalendar formatado para a rotação do usuário.

Tabela 9. Parâmetros

Nome	Tipo	Descrição
groupId	Cadeia de caracteres	O SYS ID do grupo.
rotaId	Cadeia de caracteres	O ID do sistema de rotação.
userId	Cadeia de caracteres	O SYS ID do usuário.
dateRangeObj	Objeto	Contém as datas iniciais e finais do conjunto de dados.
usarCache	Booliano	Se for verdadeiro, usará a tabela de cache cmn_rota_resp_cache.

Tabela 10. Retorna

Tipo	Descrição
Cadeia de caracteres	iCalendar formatado para a rotação do usuário.

OCRotaICalendarSNC - getEventsFromTable (cadeia de caracteres groupId, cadeia de caracteres rotaId, cadeia de caracteres userId, objeto dateRangeObj)

Retorna o iCalendar formatado para a rotação do usuário, se encontrado na tabela cmn_rota_resp_cache.

Tabela 11. Parâmetros

Nome	Tipo	Descrição
groupId	Cadeia de caracteres	O SYS ID do grupo.
rotaId	Cadeia de caracteres	O ID do sistema de rotação.
userId	Cadeia de caracteres	O SYS ID do usuário.
dateRangeObj	Objeto	Contém as datas iniciais e finais do conjunto de dados.

Tabela 12. Retorna

Tipo	Descrição
Cadeia de caracteres	iCalendar formatado para a rotação do usuário, se encontrado na tabela cmn_rota_resp_cache.

OCRotaICalendarSNC - getIntersectRotaSpanItem (ScheduleTimeSpan timeSpan, matriz rotaSpanItems)

Verifica se o timeSpan fornecido cruza com um dos itens de período de rotação.

Tabela 13. Parâmetros

Nome	Tipo	Descrição
intervalo de tempo	ScheduleTimeSpan	Um único período para o plantão do usuário.
rotaSpanItems	Matriz	Contém os períodos de plantão padrão do usuário.

Tabela 14. Retorna

Tipo	Descrição
Objeto	Se o timeSpan fizer interseção com um dos itens de período de rotação, retornará um objeto que contém o item de período de rotação e o período com o qual ele faz a interseção.

OCRotaICalendarSNC - getMemberCalendarURL (cadeia de caracteres groupId, objeto rotaId, cadeia de caracteres userId)

Cria o URL sujeito à assinatura para o iCalendar do usuário.

Tabela 15. Parâmetros

Nome	Tipo	Descrição
groupId	Cadeia de caracteres	O SYS ID do grupo.
rotaId	Objeto	O ID do sistema de rotação.
userId	Cadeia de caracteres	O SYS ID do usuário.

Tabela 16. Retorna

Tipo	Descrição
Cadeia de caracteres	O URL sujeito à assinatura para o iCalendar do usuário.

OCRotaICalendarSNC - getOnCallCalendarURL (GlideRecord rotaGR)

Retorna um URL para o calendário de plantão com base no registro de rotação.

Tabela 17. Parâmetros

Nome	Tipo	Descrição
rotaGR	GlideRecord	Um registro cmn_rota.

Tabela 18. Retorna

Tipo	Descrição
Cadeia de caracteres	URL para o calendário de plantão com base no registro de rotação.

OCRotaICalendarSNC - handleOverrideMember (AJAXScheduleItem scheduleItem)

Retorna uma matriz de substituições do usuário (cobertura extra).

Tabela 19. Parâmetros

Nome	Tipo	Descrição
item de programação	AJAXScheduleItem	Uma lista de AJAXScheduleItems.

Tabela 20. Retorna

Tipo	Descrição
Matriz	Uma matriz de substituições do usuário (cobertura extra).

OCRotaICalendarSNC - handleRotaMember (AjaxSchedueItem scheduleItem , Objeto rotaSpanItems, Definição de objetoItems, Matriz repeatRotaSpanIdArr)

Retorna um objeto que contém a substituição do usuário (cobertura extra) e períodos excluídos.

Tabela 21. Parâmetros

Nome	Tipo	Descrição
item de programação	AJAXSchedueItem	Uma lista de AJAXScheduleItems.
rotaSpanItems	Objeto	Contém os períodos de plantão padrão do usuário.
itens de definição	Objeto	Contém os períodos de plantão padrão da rotação.
repeatRotaSpanIdArr	Matriz	Uma matriz de SYS IDs de período de rotação.

Tabela 22. Retorna

Tipo	Descrição
Objeto	Contém a substituição do usuário (cobertura extra) e os períodos excluídos.

OCRotaICalendarSNC - invalRotaRespCache (GlideRecord rotaRespCacheGR)

Usado por regras de negócios nas tabelas cmn_rota_member, cmn_schedule_span e roster_schedule_span para atualizar a tabela cmn_rota_resp_cache.

Tabela 23. Parâmetros

Nome	Tipo	Descrição
rotaRespCacheGR	GlideRecord	Registro que foi atualizado.

Tabela 24. Retorna

Tipo	Descrição
vazio

OCRotaICalendarSNC -matchRotaSpanRule(ScheduleTimeSpan timeSpan, matriz rotaSpanItems, matriz repeatRotaSpanIdArr, objeto seriesStartTimes)

Verifica se o timeSpan fornecido corresponde a um dos rotaSpanItems.

Tabela 25. Parâmetros

Nome	Tipo	Descrição
intervalo de tempo	ScheduleTimeSpan	Um único período para o plantão do usuário.
rotaSpanItems	Matriz	Contém os períodos de plantão padrão do usuário.
repeatRotaSpanIdArr	Matriz	Uma matriz de SYS IDs de período de rotação.
seriesStartTimes	Objeto	Hora de início dos períodos de rotação.

Tabela 26. Retorna

Tipo	Descrição
Booliano	Retorna verdadeiro se o timeSpan corresponder a um dos rotaSpanItems.

OCRotaICalendarSNC - populateCalendarSubscriptionSettings ()

Usado pelo trabalho fixo para preencher os campos de assinatura de calendário no formulário cmn_rota

Tabela 27. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 28. Retorna

Tipo	Descrição
vazio

OCRotaICalendarSNC - processSeriesEvent (lista scheduleItems, matriz repeatRotaSpanIdArr , cadeia de caracteres userId)

Retorna um objeto que contém as rotações do usuário.

Tabela 29. Parâmetros

Nome	Tipo	Descrição
itens de programação	Lista	A rotação de plantão do usuário como uma lista AJAXScheduleItem.
repeatRotaSpanIdArr	Matriz	Uma matriz do registro de período de programação cmn_rota sys_ids.
userId	Cadeia de caracteres	O SYS ID do usuário.

Tabela 30. Retorna

Tipo	Descrição
Objeto	Contém as rotações do usuário.

OCRotaICalendarSNC - saveCalendarEvents (cadeia de caracteres groupId, cadeia de caracteres rotaId, cadeia de caracteres userId, objeto dateRangeObj, resultado da cadeia de caracteres)

Insere o iCalendar do usuário na tabela cmn_rota_resp_cache.

Tabela 31. Parâmetros

Nome	Tipo	Descrição
groupId	Cadeia de caracteres	O SYS ID do grupo.
rotaId	Cadeia de caracteres	O ID do sistema de rotação.
userId	Cadeia de caracteres	O SYS ID do usuário.
dateRangeObj	Objeto	Contém as datas iniciais e finais do conjunto de dados.
resultado	Cadeia de caracteres	O iCalendar do usuário.

Tabela 32. Retorna

Tipo	Descrição
vazio

OCRotaICalendarSNC - sendCalendarURL (GlideRecord rotaGR)

Enfileira eventos para enviar um e-mail a todos os membros da rotação.

Tabela 33. Parâmetros

Nome	Tipo	Descrição
rotaGR	GlideRecord	Um registro cmn_rota.

Tabela 34. Retorna

Tipo	Descrição
vazio

OCRotaICalendarSNC - updateExceptionList (AJAXScheduleItem scheduleItem, ScheduleTimeSpan timeSpan, matriz rotaSpanItems)

Retorna um objeto que contém todos os timeSpans que precisam ser excluídos do iCalendar do usuário.

Tabela 35. Parâmetros

Nome	Tipo	Descrição
item de programação	AJAXScheduleItem	Um AJAXScheduleItem.
intervalo de tempo	ScheduleTimeSpan	Período de plantão padrão de um único usuário.
rotaSpanItems	Matriz	Contém os períodos de plantão padrão do usuário.

Tabela 36. Retorna

Tipo	Descrição
Objeto	Objeto que contém todos os timeSpans que precisam ser excluídos do iCalendar do usuário.