OCRotaICalendarSNC - Global

L’API OCRotaICalendarSNC fournit des événements au format iCal pour la rotation d’un utilisateur spécifique.

OCRotaICalendarSNC : cleanExpiredCache ()

Enregistrements de la table cmn_rota_resp_cache dont la date de début est antérieure à aujourd’hui.

Tableau 1. Paramètres

Nom	Type	Description
Aucun

Tableau 2. Renvoie

Type	Description
nul

OCRotaICalendarSNC – createCalendarEvents (chaîne groupId, chaîne rotaId, chaîne userId, objet dateRangeObj)

Renvoie la liste des AJAXScheduleItems pour l’astreinte de l’utilisateur.

Tableau 3. Paramètres

Nom	Type	Description
groupId	Chaîne	L’ID système du groupe.
rotaId	Chaîne	L’ID système de la rotation.
userId	Chaîne	L’ID système de l’utilisateur.
dateRangeObj	Objet	Contient les dates de début et de fin de l’ensemble de données.

Tableau 4. Renvoie

Type	Description
AJAXScheduleItem	Liste Java des AJAXScheduleItems.

OCRotaICalendarSNC – createCustomEvent (String groupName, Object scheduleItemSpan, String calendarLink)

Crée un VEVENT en fonction du scheduleItemSpan fourni.

Tableau 5. Paramètres

Nom	Type	Description
groupName	Chaîne	Nom du groupe d’astreinte.
scheduleItemSpan (en anglais seulement)	Objet	Durée de la période d’astreinte.
calendarLink	Chaîne	Un lien de retour vers le calendrier d’astreinte dans l’instance.

Tableau 6. Renvoie

Type	Description
Chaîne	VEVENT basé sur le scheduleItemSpan fourni.

OCRotaICalendarSNC : createPlaceholderCalendar (GlideRecord rotaGR, Object dateRangeObj, String calendarLink)

Crée un iCalendar formaté si l’utilisateur n’a pas d’astreinte à venir.

Tableau 7. Paramètres

Nom	Type	Description
rotaGR	GlideRecord	Le cmn_rota l’enregistrement de Glide.
dateRangeObj	Objet	Contient les dates de début et de fin de l’ensemble de données.
calendarLink	Chaîne	Un lien vers le calendrier d’astreinte de cet utilisateur.

Tableau 8. Renvoie

Type	Description
Chaîne	iCalendar formaté avec un espace réservé VEVENT.

OCRotaICalendarSNC : getCalendarEvents (chaîne groupId , chaîne rotaId, chaîne userId , objet dateRangeObj, booléen useCache)

Renvoie l’iCalendar formaté pour la rotation de l’utilisateur.

Tableau 9. Paramètres

Nom	Type	Description
groupId	Chaîne	L’ID système du groupe.
rotaId	Chaîne	L’ID système de la rotation.
userId	Chaîne	L’ID système de l’utilisateur.
dateRangeObj	Objet	Contient les dates de début et de fin de l’ensemble de données.
useCache (en anglais)	Booléen	Si vrai, utilise la table de cache cmn_rota_resp_cache.

Tableau 10. Renvoie

Type	Description
Chaîne	iCalendar formaté pour la rotation de l’utilisateur.

OCRotaICalendarSNC : getEventsFromTable (chaîne groupId, chaîne rotaId, chaîne userId, objet dateRangeObj)

Renvoie l’iCalendar formaté pour la rotation de l’utilisateur s’il se trouve dans la table cmn_rota_resp_cache.

Tableau 11. Paramètres

Nom	Type	Description
groupId	Chaîne	L’ID système du groupe.
rotaId	Chaîne	L’ID système de la rotation.
userId	Chaîne	L’ID système de l’utilisateur.
dateRangeObj	Objet	Contient les dates de début et de fin de l’ensemble de données.

Tableau 12. Renvoie

Type	Description
Chaîne	iCalendar formaté pour la rotation de l’utilisateur s’il se trouve dans la table cmn_rota_resp_cache.

OCRotaICalendarSNC : getIntersectRotaSpanItem (ScheduleTimeSpan timeSpan, Array rotaSpanItems)

Vérifie si le timeSpan fourni croise l’un des éléments de rotation de parcours.

Tableau 13. Paramètres

Nom	Type	Description
Timespan	ScheduleTimeSpan (Intervalle de temps d’échéancier)	Un parcours unique pour l’astreinte de l’utilisateur.
éléments rotaSpanItems	Tableau	Contient les plages d’astreinte standard de l’utilisateur.

Tableau 14. Renvoie

Type	Description
Objet	Si timeSpan croise l’un des éléments de rotation de parcours, renvoie un objet contenant l’élément de rotation de parcours et le parcours avec lequel il intersecte.

OCRotaICalendarSNC : getMemberCalendarURL (chaîne groupId, objet rotaId, chaîne userId)

Crée l’URL à abonnement possible pour l’iCalendar de l’utilisateur.

Tableau 15. Paramètres

Nom	Type	Description
groupId	Chaîne	L’ID système du groupe.
rotaId	Objet	L’ID système de la rotation.
userId	Chaîne	L’ID système de l’utilisateur.

Tableau 16. Renvoie

Type	Description
Chaîne	URL à abonnement possible pour l’iCalendar de l’utilisateur.

OCRotaICalendarSNC : getOnCallCalendarURL (rotaGR GlideRecord)

Renvoie une URL au calendrier d’astreinte en fonction de l’enregistrement de rotation.

Tableau 17. Paramètres

Nom	Type	Description
rotaGR	GlideRecord	Un record cmn_rota.

Tableau 18. Renvoie

Type	Description
Chaîne	URL du calendrier d’astreinte en fonction de l’enregistrement de rotation.

OCRotaICalendarSNC : handleOverrideMember (AJAXScheduleItem scheduleItem)

Renvoie un tableau des remplacements de l’utilisateur (couverture supplémentaire).

Tableau 19. Paramètres

Nom	Type	Description
Élément de calendrier	AJAXScheduleItem	Une liste de AJAXScheduleItems.

Tableau 20. Renvoie

Type	Description
Tableau	Tableau des remplacements de l’utilisateur (couverture supplémentaire).

OCRotaICalendarSNC - handleRotaMember (AjaxSchedueItem scheduleItem , objet rotaSpanItems, object definitionItems, Array repeatRotaSpanIdArr)

Renvoie un objet contenant le remplacement de l’utilisateur (couverture supplémentaire) et les étendues exclues.

Tableau 21. Paramètres

Nom	Type	Description
Élément de calendrier	AJAXSchedueItem (Élément AJAXSchedue)	Une liste de AJAXScheduleItems.
éléments rotaSpanItems	Objet	Contient les plages d’astreinte standard de l’utilisateur.
Éléments de définition	Objet	Contient les plages d’astreinte standard de la rotation.
repeatRotaSpanIdArr	Tableau	Tableau des ID système du parcours de rotation.

Tableau 22. Renvoie

Type	Description
Objet	Contient le remplacement de l’utilisateur (couverture supplémentaire) et les étendues exclues.

OCRotaICalendarSNC : invalRotaRespCache (GlideRecord rotaRespCacheGR)

Utilisé par les règles métier sur les tables cmn_rota_member, cmn_schedule_span et roster_schedule_span pour mettre à jour la table cmn_rota_resp_cache.

Tableau 23. Paramètres

Nom	Type	Description
rotaRespCacheGR	GlideRecord	Enregistrement qui a été mis à jour.

Tableau 24. Renvoie

Type	Description
nul

OCRotaICalendarSNC : matchRotaSpanRule(ScheduleTimeSpan timeSpan, Array rotaSpanItems, Array repeatRotaSpanIdArr, Object seriesStartTimes)

Vérifie si le timeSpan fourni correspond à l’un des rotaSpanItems.

Tableau 25. Paramètres

Nom	Type	Description
Timespan	ScheduleTimeSpan (Intervalle de temps d’échéancier)	Un parcours unique pour l’astreinte de l’utilisateur.
éléments rotaSpanItems	Tableau	Contient les plages d’astreinte standard de l’utilisateur.
repeatRotaSpanIdArr	Tableau	Tableau des ID système du parcours de rotation.
seriesStartTime	Objet	Heure de début des périodes de rotation.

Tableau 26. Renvoie

Type	Description
Booléen	Renvoie la valeur true si timeSpan correspond à l’un des rotaSpanItems.

OCRotaICalendarSNC : populateCalendarSubscriptionSettings ()

Utilisé par la tâche fixe pour renseigner les champs d’abonnement au calendrier sur le formulaire cmn_rota

Tableau 27. Paramètres

Nom	Type	Description
Aucun

Tableau 28. Renvoie

Type	Description
nul

OCRotaICalendarSNC : processSeriesEvent (List scheduleItems, Array repeatRotaSpanIdArr , String userId)

Renvoie un objet contenant les rotations de l’utilisateur.

Tableau 29. Paramètres

Nom	Type	Description
Éléments de calendrier	Liste	La rotation d’astreinte de l’utilisateur sous forme de liste AJAXScheduleItem.
repeatRotaSpanIdArr	Tableau	Tableau des sys_ids d’enregistrement du parcours de calendrier cmn_rota.
userId	Chaîne	L’ID système de l’utilisateur.

Tableau 30. Renvoie

Type	Description
Objet	Contient les rotations de l’utilisateur.

OCRotaICalendarSNC – saveCalendarEvents (chaîne groupId, chaîne rotaId, chaîne userId, objet dateRangeObj, chaîne résultat)

Insère l’iCalendar de l’utilisateur dans la table cmn_rota_resp_cache.

Tableau 31. Paramètres

Nom	Type	Description
groupId	Chaîne	L’ID système du groupe.
rotaId	Chaîne	L’ID système de la rotation.
userId	Chaîne	L’ID système de l’utilisateur.
dateRangeObj	Objet	Contient les dates de début et de fin de l’ensemble de données.
résultat	Chaîne	L’iCalendar de l’utilisateur.

Tableau 32. Renvoie

Type	Description
nul

OCRotaICalendarSNC : sendCalendarURL (rotaGR GlideRecord)

Met en file d’attente les événements pour envoyer un e-mail à tous les membres de la rotation.

Tableau 33. Paramètres

Nom	Type	Description
rotaGR	GlideRecord	Un record cmn_rota.

Tableau 34. Renvoie

Type	Description
nul

OCRotaICalendarSNC : updateExceptionList (AJAXScheduleItem, scheduleItem, ScheduleTimeSpan, timeSpan, Array, rotaSpanItems)

Renvoie un objet contenant tous les intervalles de temps qui doivent être exclus de l’iCalendar de l’utilisateur.

Tableau 35. Paramètres

Nom	Type	Description
Élément de calendrier	AJAXScheduleItem	Un AJAXScheduleItem.
Timespan	ScheduleTimeSpan (Intervalle de temps d’échéancier)	Plage d’astreinte standard d’un seul utilisateur.
éléments rotaSpanItems	Tableau	Contient les plages d’astreinte standard de l’utilisateur.

Tableau 36. Renvoie

Type	Description
Objet	Objet contenant tous les intervalles de temps qui doivent être exclus de l’iCalendar de l’utilisateur.