fr.paris.lutece.plugins.calendar.modules.ical
Class ICalAgenda

java.lang.Object
  extended by fr.paris.lutece.plugins.calendar.modules.ical.ICalAgenda
All Implemented Interfaces:
Agenda

public class ICalAgenda
extends java.lang.Object
implements Agenda

This class is an implementation of an Agenda using the iCalendar format (RFC 2445).


Constructor Summary
ICalAgenda()
           
 
Method Summary
 void addEvent(Event event)
          Add an event to the agenda
 java.util.List getEvents()
          Retrieves all events of the agenda
 java.util.List getEventsByDate(java.lang.String strDate)
          Retrieves events for a given date
 java.util.List getEventsByDate(java.lang.String strDateBegin, java.lang.String strDateEnd)
          The events which occur between a start and end date
 java.lang.String getKeyName()
          Returns the KeyName
 java.lang.String getName()
          Returns the name of the Agenda
 boolean hasEvents(java.lang.String strDate)
          Indicates if the agenda gets events for a given date
 void setEvents(net.fortuna.ical4j.model.Calendar calendar)
          Sets events of the agenda
 void setKeyName(java.lang.String strKeyName)
          Sets the KeyName
 void setName(java.lang.String strName)
          Defines the name of the Agenda
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ICalAgenda

public ICalAgenda()
Method Detail

getName

public java.lang.String getName()
Returns the name of the Agenda

Specified by:
getName in interface Agenda
Returns:
The agenda's name

setName

public void setName(java.lang.String strName)
Defines the name of the Agenda

Specified by:
setName in interface Agenda
Parameters:
strName - The agenda's name

getKeyName

public java.lang.String getKeyName()
Returns the KeyName

Specified by:
getKeyName in interface Agenda
Returns:
The KeyName

setKeyName

public void setKeyName(java.lang.String strKeyName)
Sets the KeyName

Specified by:
setKeyName in interface Agenda
Parameters:
strKeyName - The KeyName

hasEvents

public boolean hasEvents(java.lang.String strDate)
Indicates if the agenda gets events for a given date

Specified by:
hasEvents in interface Agenda
Parameters:
strDate - A date code
Returns:
True if there is events, otherwise false

getEventsByDate

public java.util.List getEventsByDate(java.lang.String strDate)
Retrieves events for a given date

Specified by:
getEventsByDate in interface Agenda
Parameters:
strDate - A date code
Returns:
A list of events

getEvents

public java.util.List getEvents()
Retrieves all events of the agenda

Specified by:
getEvents in interface Agenda
Returns:
A list of events

setEvents

public void setEvents(net.fortuna.ical4j.model.Calendar calendar)
Sets events of the agenda

Parameters:
calendar - An iCal calendar

addEvent

public void addEvent(Event event)
Add an event to the agenda

Parameters:
event - The event to add

getEventsByDate

public java.util.List getEventsByDate(java.lang.String strDateBegin,
                                      java.lang.String strDateEnd)
The events which occur between a start and end date

Specified by:
getEventsByDate in interface Agenda
Parameters:
strDateBegin - The start date
strDateEnd - The end date
Returns:
The list of events


Copyright © 2007 Mairie de Paris. All Rights Reserved.