Package org.ametys.plugins.hyperplanning

Class HyperplanningManager

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.hyperplanning.HyperplanningManager

All Implemented Interfaces:

LogEnabled, Initializable, Component, Serviceable

public class HyperplanningManager
extends AbstractLogEnabled
implements Initializable, Component, Serviceable

Component handling the communication with a remote hyperplanning server

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	HyperplanningManager.CancelledLesson	Represent a cancelled lesson from hyperplanning

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ROLE	The avalon role

Constructor Summary

Constructors

Constructor	Description
HyperplanningManager()

Method Summary

Modifier and Type	Method	Description
protected String	_getStudentIcal(UserIdentity userIdentity)	Get the timetable of a student
Map<HyperplanningManager.CancelledLesson,List<String>>	getCancelledLessons(LocalDateTime cancellationMinDate, LocalDateTime lessonMinDate, LocalDateTime lessonMaxDate)	Get the list of cancelled lessons and the impacted students.
protected Optional<String>	getEtudiantCle(UserIdentity userIdentity)	Get the hyperplanning student key corresponding to the user identity
String	getStudentIcal(UserIdentity userIdentity)	Get the timetable of a student
Set<HyperplanningManager.CancelledLesson>	getUpcomingCancelledLessons(UserIdentity userIdentity)	Get the list of cancelled lessons for a given user in the next 2 weeks
void	initialize()
void	service(ServiceManager manager)

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ROLE

public static final String ROLE

The avalon role

Constructor Details

HyperplanningManager

public HyperplanningManager()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

getStudentIcal

public String getStudentIcal(UserIdentity userIdentity)

Get the timetable of a student

Parameters:

userIdentity - the student identity

Returns:

the timetable as an ICS string

_getStudentIcal

protected String _getStudentIcal(UserIdentity userIdentity)

Get the timetable of a student

Parameters:

userIdentity - the student identity

Returns:

the timetable as an ICS string

getUpcomingCancelledLessons

public Set<HyperplanningManager.CancelledLesson> getUpcomingCancelledLessons(UserIdentity userIdentity)
                                                                      throws UnknownStudentException

Get the list of cancelled lessons for a given user in the next 2 weeks

Parameters:

userIdentity - the user identity

Returns:

a list of HyperplanningManager.CancelledLesson representing the cancelled lessons or null if the user is unknown

Throws:

UnknownStudentException - when user is not linked to hyperplanning

getCancelledLessons

public Map<HyperplanningManager.CancelledLesson,List<String>> getCancelledLessons(LocalDateTime cancellationMinDate,
 LocalDateTime lessonMinDate,
 LocalDateTime lessonMaxDate)

Get the list of cancelled lessons and the impacted students.

Parameters:

cancellationMinDate - a date to only return lessons that were cancelled after that date, or null.

lessonMinDate - a date to only return lessons that start after that date, or null.

lessonMaxDate - a date to only return lessons that start before that date, or null.

Returns:

a map of cancelled lessons with the impacted CAS identifier

getEtudiantCle

protected Optional<String> getEtudiantCle(UserIdentity userIdentity)
                                   throws com.indexeducation.hyperplanning.ApiException

Get the hyperplanning student key corresponding to the user identity

Parameters:

userIdentity - the user identity

Returns:

the cle or empty if the user doesn't match a hyperplanning student

Throws:

com.indexeducation.hyperplanning.ApiException - if an error occurs