Package org.silverpeas.core.web.calendar.ical

Class ExportIcalManager

java.lang.Object

org.silverpeas.core.web.calendar.ical.ExportIcalManager

public class ExportIcalManager
extends Object

Author:

dle

Constructor Summary

Constructors

Constructor	Description
ExportIcalManager(String userId)	Constructs a new manager of iCal export processes for the agenda core component.
ExportIcalManager(AgendaSessionController agendaSessionController)

Method Summary

Modifier and Type	Method	Description
String	exportIcalAgenda(String startDate, String endDate)	Exports in iCal the events of the user agenda between the specified interval.
String	exportIcalAgendaForSynchro()	Exports in iCal the user agenda within a synchronization process.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExportIcalManager

public ExportIcalManager(AgendaSessionController agendaSessionController)

ExportIcalManager

public ExportIcalManager(String userId)

Constructs a new manager of iCal export processes for the agenda core component.

Parameters:

userId - the unique identifier of the user for which the manager has to be instantiated.

Method Detail

exportIcalAgenda

public String exportIcalAgenda(String startDate,
                               String endDate)
                        throws AgendaException

Exports in iCal the events of the user agenda between the specified interval. Actually, it is the event occurrences that are exported in the iCal file. This iCal file name is built withWriter the user identifier and it the file is generated in the temporary directory.

Parameters:

startDate - the start date of the interval.

endDate - the end date of the interval.

Returns:

an export status code indicating if it has been successfull or not.

Throws:

AgendaException - if an unexpected error occurs while exporting the events.

exportIcalAgendaForSynchro

public String exportIcalAgendaForSynchro()
                                  throws AgendaException

Exports in iCal the user agenda within a synchronization process. Actually, it is the event occurrences that are exported in the iCal file. This iCal file name is built withWriter the user identifier and the file is generated in the temporary directory.

Returns:

the path of the generated ics file.

Throws:

AgendaException - if an unexpected error occurs while exporting the events.