fr.paris.lutece.plugins.calendar.business
Interface Agenda

All Known Implementing Classes:
ICalAgenda, MultiAgenda, SimpleAgenda

public interface Agenda

This interface describes the minimum implementation for agendas


Method Summary
 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)
          Retrieves events for a given date
 java.lang.String getKeyName()
          Returns the key of the Agenda
 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 setKeyName(java.lang.String strKeyName)
          Sets the key of the Agenda
 void setName(java.lang.String strName)
          Sets the name of the Agenda
 

Method Detail

hasEvents

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

Parameters:
strDate - A date code
Returns:
True if there is events, otherwise false

getEventsByDate

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

Parameters:
strDate - A date code
Returns:
A list of events

getEventsByDate

java.util.List getEventsByDate(java.lang.String strDateBegin,
                               java.lang.String strDateEnd)
Retrieves events for a given date

Parameters:
strDateBegin - The start date
strDateEnd - The end date
Returns:
A list of events

getEvents

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

Returns:
A list of events

getName

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

Returns:
The agenda's name

setName

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

Parameters:
strName - The agenda's name

getKeyName

java.lang.String getKeyName()
Returns the key of the Agenda

Returns:
The agenda's key

setKeyName

void setKeyName(java.lang.String strKeyName)
Sets the key of the Agenda

Parameters:
strKeyName - The agenda's key name


Copyright © 2007 Mairie de Paris. All Rights Reserved.