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

All Known Implementing Classes:
CalendarDAO

public interface ICalendarDAO

AN interface used to access the calendar business layer


Method Summary
 void deleteAgenda(int nAgendaId, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Delete a Agenda from the table calendar_agendas
 void deleteEvent(int nAgendaId, int nEventId, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Delete an Event from the table calendar_events
 void insertAgenda(AgendaResource agenda, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Insert a new agenda in the table calendar_agendas.
 void insertEvent(int nAgendaId, SimpleEvent event, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Insert a new event in the table calendar_events.
 AgendaResource loadAgenda(int nId, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Load the data of AgendaResource from the table
 SimpleEvent loadEvent(int nEventId, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Load the data of SimpleEvent from the table
 java.util.List<AgendaResource> selectAgendaResourceList(fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Load the list of AgendaResources
 java.util.List<SimpleEvent> selectEventsList(int nAgendaId, int nSortEvents, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Load the list of Events
 void storeAgenda(AgendaResource agenda, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Update the agenda in the table calendar_agendas
 void storeEvent(int nAgendaId, SimpleEvent event, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Update the event in the table calendar_event
 

Method Detail

deleteEvent

void deleteEvent(int nAgendaId,
                 int nEventId,
                 fr.paris.lutece.portal.service.plugin.Plugin plugin)
Delete an Event from the table calendar_events

Parameters:
nEventId - The id of the event
nAgendaId - The Agenda Id
plugin - The Plugin using this data access service

deleteAgenda

void deleteAgenda(int nAgendaId,
                  fr.paris.lutece.portal.service.plugin.Plugin plugin)
Delete a Agenda from the table calendar_agendas

Parameters:
nAgendaId - The agenda Id
plugin - The Plugin using this data access service

insertEvent

void insertEvent(int nAgendaId,
                 SimpleEvent event,
                 fr.paris.lutece.portal.service.plugin.Plugin plugin)
                 throws fr.paris.lutece.portal.service.util.AppException
Insert a new event in the table calendar_events.

Parameters:
nAgendaId - The agenda id
event - The event
plugin - The Plugin using this data access service
Throws:
fr.paris.lutece.portal.service.util.AppException - An AppException error

insertAgenda

void insertAgenda(AgendaResource agenda,
                  fr.paris.lutece.portal.service.plugin.Plugin plugin)
Insert a new agenda in the table calendar_agendas.

Parameters:
agenda - The AgendaResource object
plugin - The Plugin using this data access service

loadAgenda

AgendaResource loadAgenda(int nId,
                          fr.paris.lutece.portal.service.plugin.Plugin plugin)
Load the data of AgendaResource from the table

Parameters:
nId - The identifier of AgendaResource
plugin - The plugin
Returns:
the instance of the AgendaResource

loadEvent

SimpleEvent loadEvent(int nEventId,
                      fr.paris.lutece.portal.service.plugin.Plugin plugin)
Load the data of SimpleEvent from the table

Parameters:
nEventId - The id of the event
plugin - The plugin
Returns:
the instance of the SimpleEvent

selectAgendaResourceList

java.util.List<AgendaResource> selectAgendaResourceList(fr.paris.lutece.portal.service.plugin.Plugin plugin)
Load the list of AgendaResources

Parameters:
plugin - The plugin
Returns:
The Collection of the AgendaResources

selectEventsList

java.util.List<SimpleEvent> selectEventsList(int nAgendaId,
                                             int nSortEvents,
                                             fr.paris.lutece.portal.service.plugin.Plugin plugin)
Load the list of Events

Parameters:
nSortEvents - Parameter used for event sorting
plugin - The plugin
nAgendaId - The identifier of the agenda
Returns:
The Collection of the Events

storeAgenda

void storeAgenda(AgendaResource agenda,
                 fr.paris.lutece.portal.service.plugin.Plugin plugin)
Update the agenda in the table calendar_agendas

Parameters:
agenda - The reference of AgendaResource
plugin - The Plugin using this data access service

storeEvent

void storeEvent(int nAgendaId,
                SimpleEvent event,
                fr.paris.lutece.portal.service.plugin.Plugin plugin)
                throws fr.paris.lutece.portal.service.util.AppException
Update the event in the table calendar_event

Parameters:
event - The reference of SimpleEvent
nAgendaId - The identifier of the agenda
plugin - The Plugin using this data access service
Throws:
fr.paris.lutece.portal.service.util.AppException - An AppException


Copyright © 2008 Mairie de Paris. All Rights Reserved.