org.sakaiproject.signup.dao

Interface SignupMeetingDao

All Superinterfaces:

org.sakaiproject.genericdao.api.finders.AllFinder, org.sakaiproject.genericdao.api.BasicGenericDao, org.sakaiproject.genericdao.api.modifiers.BasicModifier, org.sakaiproject.genericdao.api.modifiers.BatchModifier, org.sakaiproject.genericdao.api.finders.ByPropsFinder, org.sakaiproject.genericdao.api.finders.BySearchFinder, org.sakaiproject.genericdao.api.GeneralGenericDao, org.sakaiproject.genericdao.api.GenericDao

All Known Implementing Classes:

SignupMeetingDaoImpl

public interface SignupMeetingDao
extends org.sakaiproject.genericdao.api.GeneralGenericDao

SignupMeetingDao is an interface, which provides methods to access the database storage for retrieving, creating, updating and removing SignupMeeting objects.

Author:

Peter Liu

Field Summary

Fields inherited from interface org.sakaiproject.genericdao.api.finders.ByPropsFinder

ASC, DESC, EQUALS, GREATER, LESS, LIKE, NOT_EQUALS, NOT_NULL, NULL

Method Summary

Methods

Modifier and Type	Method and Description
List<String>	getAllCategories(String siteId) Get all the Categories from a site
List<String>	getAllLocations(String siteId) Get all the Locations from a site
List<org.sakaiproject.signup.model.SignupMeeting>	getAllSignupMeetings(String siteId) This returns a list of SignupMeeting for the site
List<org.sakaiproject.signup.model.SignupMeeting>	getAutoReminderSignupMeetings(Date startDate, Date endDate) This returns a subset list of SignupMeeting from startDate to endDate for the sites, which have auto-reminder setting
int	getAutoReminderTotalEventCounts(Date startDate, Date endDate) Get total Events record-Counts for auto-reminder process
List<org.sakaiproject.signup.model.SignupMeeting>	getRecurringSignupMeetings(String currentSiteId, Long recurrenceId, Date startDate) This returns a subset list of SignupMeetings with the same recurrenceId from a starting Date for the site
List<org.sakaiproject.signup.model.SignupMeeting>	getSignupMeetings(String currentSiteId, Date searchEndDate) This returns a subset list of SignupMeeting from Now to searchEndDate for the site
List<org.sakaiproject.signup.model.SignupMeeting>	getSignupMeetings(String siteId, Date startDate, Date endDate) This returns a subset list of SignupMeeting from startDate to endDate for the site
List<org.sakaiproject.signup.model.SignupMeeting>	getSignupMeetingsInSite(String siteId, Date startDate, Date endDate) This returns a subset list of SignupMeetings from startDate to endDate for the defined site
List<org.sakaiproject.signup.model.SignupMeeting>	getSignupMeetingsInSites(List<String> siteIds, Date startDate, Date endDate) This returns a subset list of SignupMeetings from startDate to endDate for the defined sites
boolean	isEventExisted(Long evnetId) Test to see if the event exists.
org.sakaiproject.signup.model.SignupMeeting	loadSignupMeeting(Long meetingId) This retrieve a SignupMeeting object from database according to the SignupMeeting Id
void	removeMeetings(List<org.sakaiproject.signup.model.SignupMeeting> meetings) This deletes a list of SignupMeeting objects.
Long	saveMeeting(org.sakaiproject.signup.model.SignupMeeting signupMeeting) This saves meeting object into database
void	saveMeetings(List<org.sakaiproject.signup.model.SignupMeeting> signupMeetings) This saves a list of meeting object into database
void	updateMeeting(org.sakaiproject.signup.model.SignupMeeting meeting) This updates the SignupMeeting object in the DB
void	updateMeetings(List<org.sakaiproject.signup.model.SignupMeeting> meetings) This updates a list of SignupMeeting objects in the DB
void	updateModifiedMeetings(List<org.sakaiproject.signup.model.SignupMeeting> meetings, List<org.sakaiproject.signup.model.SignupTimeslot> removedTimeslots) This updates a list of SignupMeeting objects in the DB

Methods inherited from interface org.sakaiproject.genericdao.api.GenericDao

findById, getIdProperty, getPersistentClasses, invokeTransactionalAccess

Methods inherited from interface org.sakaiproject.genericdao.api.modifiers.BasicModifier

create, delete, delete, save, update

Methods inherited from interface org.sakaiproject.genericdao.api.finders.ByPropsFinder

countByProperties, countByProperties, findByProperties, findByProperties, findByProperties, findByProperties, findByProperties

Methods inherited from interface org.sakaiproject.genericdao.api.finders.BySearchFinder

countBySearch, findBySearch, findOneBySearch

Methods inherited from interface org.sakaiproject.genericdao.api.finders.AllFinder

countAll, findAll, findAll

Methods inherited from interface org.sakaiproject.genericdao.api.modifiers.BatchModifier

deleteMixedSet, deleteSet, deleteSet, saveMixedSet, saveSet

Method Detail

getAllSignupMeetings

List<org.sakaiproject.signup.model.SignupMeeting> getAllSignupMeetings(String siteId)

This returns a list of SignupMeeting for the site

Parameters:

siteId - - a unique id which represents the current site

Returns:

a list of SignupMeeting objects

getSignupMeetings

List<org.sakaiproject.signup.model.SignupMeeting> getSignupMeetings(String currentSiteId,
                                                                  Date searchEndDate)

This returns a subset list of SignupMeeting from Now to searchEndDate for the site

Parameters:

currentSiteId - a unique id which represents the current site

searchEndDate - date,which constraints the search ending date.

Returns:

a list of SignupMeeting objects

getSignupMeetings

List<org.sakaiproject.signup.model.SignupMeeting> getSignupMeetings(String siteId,
                                                                  Date startDate,
                                                                  Date endDate)

This returns a subset list of SignupMeeting from startDate to endDate for the site

Parameters:

siteId - a unique id which represents the current site

startDate - date,which constraints the search starting date.

endDate - date,which constraints the search ending date.

Returns:

a list of SignupMeeting objects

getSignupMeetingsInSite

List<org.sakaiproject.signup.model.SignupMeeting> getSignupMeetingsInSite(String siteId,
                                                                        Date startDate,
                                                                        Date endDate)

This returns a subset list of SignupMeetings from startDate to endDate for the defined site

Parameters:

siteId - a unique id which represents the multiple sites

startDate - date,which constraints the search starting date.

endDate - date,which constraints the search ending date.

Returns:

a list of SignupMeeting objects

getSignupMeetingsInSites

List<org.sakaiproject.signup.model.SignupMeeting> getSignupMeetingsInSites(List<String> siteIds,
                                                                         Date startDate,
                                                                         Date endDate)

This returns a subset list of SignupMeetings from startDate to endDate for the defined sites

Parameters:

siteIds - a collection of unique ids which represents the multiple sites

startDate - date,which constraints the search starting date.

endDate - date,which constraints the search ending date.

Returns:

a list of SignupMeeting objects

getRecurringSignupMeetings

List<org.sakaiproject.signup.model.SignupMeeting> getRecurringSignupMeetings(String currentSiteId,
                                                                           Long recurrenceId,
                                                                           Date startDate)

This returns a subset list of SignupMeetings with the same recurrenceId from a starting Date for the site

Parameters:

currentSiteId - a unique id which represents the current site

recurrenceId - recurrenceId,which constraints the recurring meetings.

startDate - date,which constraints the search starting date.

Returns:

a list of SignupMeeting objects

getAutoReminderSignupMeetings

List<org.sakaiproject.signup.model.SignupMeeting> getAutoReminderSignupMeetings(Date startDate,
                                                                              Date endDate)

This returns a subset list of SignupMeeting from startDate to endDate for the sites, which have auto-reminder setting

Parameters:

startDate - date,which constraints the search starting date.

endDate - date,which constraints the search ending date.

Returns:

a list of SignupMeeting objects

saveMeeting

Long saveMeeting(org.sakaiproject.signup.model.SignupMeeting signupMeeting)

This saves meeting object into database

Parameters:

signupMeeting - a SignupMeeting object

Returns:

a unique Id for the SignupMeeting object from DB

saveMeetings

void saveMeetings(List<org.sakaiproject.signup.model.SignupMeeting> signupMeetings)

This saves a list of meeting object into database

Parameters:

signupMeetings -

userId -

loadSignupMeeting

org.sakaiproject.signup.model.SignupMeeting loadSignupMeeting(Long meetingId)

This retrieve a SignupMeeting object from database according to the SignupMeeting Id

Parameters:

meetingId - a unique Id for SignupMeeting object

Returns:

a SignupMeeting object

updateMeeting

void updateMeeting(org.sakaiproject.signup.model.SignupMeeting meeting)
                   throws org.springframework.dao.DataAccessException

This updates the SignupMeeting object in the DB

Parameters:

meeting - a SignupMeeting object

Throws:

org.springframework.dao.DataAccessException - thrown if the data is not accessible

updateMeetings

void updateMeetings(List<org.sakaiproject.signup.model.SignupMeeting> meetings)
                    throws org.springframework.dao.DataAccessException

This updates a list of SignupMeeting objects in the DB

Parameters:

meetings - a list of SignupMeeting objects

Throws:

org.springframework.dao.DataAccessException - thrown if the data is not accessible

updateModifiedMeetings

void updateModifiedMeetings(List<org.sakaiproject.signup.model.SignupMeeting> meetings,
                          List<org.sakaiproject.signup.model.SignupTimeslot> removedTimeslots)
                            throws org.springframework.dao.DataAccessException

This updates a list of SignupMeeting objects in the DB

Parameters:

meetings - a list of SignupMeeting objects

removedTimeslots - a list of SignupTimeslot objects, which will be removed from the meeting

Throws:

org.springframework.dao.DataAccessException - thrown if the data is not accessible

removeMeetings

void removeMeetings(List<org.sakaiproject.signup.model.SignupMeeting> meetings)

This deletes a list of SignupMeeting objects. It should remove all or none of them in one transaction

Parameters:

meetings - a list of SignupMeeting objects, which need to be removed

isEventExisted

boolean isEventExisted(Long evnetId)

Test to see if the event exists.

Parameters:

evnetId - a Long Id for event

Returns:

true if the event is existed.

getAutoReminderTotalEventCounts

int getAutoReminderTotalEventCounts(Date startDate,
                                  Date endDate)

Get total Events record-Counts for auto-reminder process

Parameters:

startDate - search starting date

endDate - search ending date

Returns:

the total record counts

getAllCategories

List<String> getAllCategories(String siteId)
                              throws org.springframework.dao.DataAccessException

Get all the Categories from a site

Parameters:

siteId - String - a site Id

Returns:

a list of Categories in a site

Throws:

org.springframework.dao.DataAccessException

getAllLocations

List<String> getAllLocations(String siteId)
                             throws org.springframework.dao.DataAccessException

Get all the Locations from a site

Parameters:

siteId - String - a site Id

Returns:

a list of Locations in a site

Throws:

org.springframework.dao.DataAccessException