org.jasig.portlet.calendar.dao

Interface CalendarStore

All Known Implementing Classes:

HibernateCalendarStore

public interface CalendarStore

CalendarStore provides a data store for calendar listings and configurations.

Author:

Jen Bourey

Method Summary

Modifier and Type	Method and Description
void	deleteCalendarConfiguration(CalendarConfiguration configuration) Remove a calendar configuration from the data store
void	deleteCalendarDefinition(CalendarDefinition definition) Remove a calendar definition from the data store.
CalendarConfiguration	getCalendarConfiguration(Long id) Retrieve a calendar configuration.
List<UserDefinedCalendarConfiguration>	getCalendarConfigurations(String subscribeId) Retrieve a list of calendar configurations for the specified portlet.
CalendarDefinition	getCalendarDefinition(Long id) Retrieve a calendar definition.
CalendarDefinition	getCalendarDefinition(String fname)
List<PredefinedCalendarDefinition>	getHiddenPredefinedCalendarDefinitions(String subscribeId, Set<String> role) Retrieve a list of hidden predefined calendars for this portlet subscription and role.
PredefinedCalendarConfiguration	getPredefinedCalendarConfiguration(String subscribeId, String name) Retrieve a PredefinedCalendarConfiguration for the specified subscribeId and name.
List<PredefinedCalendarConfiguration>	getPredefinedCalendarConfigurations() Retrieve a list of all pre-defined calendar configurations.
List<PredefinedCalendarConfiguration>	getPredefinedCalendarConfigurations(String subscribeId, boolean visibleOnly) Retrieve a list of pre-defined calendar configurations for the specified portlet.
PredefinedCalendarDefinition	getPredefinedCalendarDefinition(Long id) Retrieve a pre-defined calendar definition
PredefinedCalendarDefinition	getPredefinedCalendarDefinitionByName(String name) Retrieve a pre-defined calendar definition based on the name field.
List<PredefinedCalendarDefinition>	getPredefinedCalendarDefinitions() Retrieves all pre-defined calendar definition
UserDefinedCalendarConfiguration	getUserDefinedCalendarConfiguration(String subscribeId, String name) Retrieve a list of all user-defined calendar configurations.
List<UserDefinedCalendarConfiguration>	getUserDefinedCalendarConfigurations() Retrieve a list of all user-defined calendar configurations.
List<UserDefinedCalendarConfiguration>	getUserDefinedCalendarConfigurations(String subscribeId, boolean visibleOnly) Retrieve a list of user-defined calendar configurations for the specified portlet.
List<String>	getUserRoles() Get a list of all user roles currently in use.
void	initCalendar(String subscribeId, Set<String> roles) Initialize calendar subscriptions for a given portlet subscription and role.
void	storeCalendarConfiguration(CalendarConfiguration configuration) Save or update a calendar configuration.
void	storeCalendarDefinition(CalendarDefinition definition) Save or update a calendar definition.

Method Detail

storeCalendarDefinition

void storeCalendarDefinition(CalendarDefinition definition)

Save or update a calendar definition.

Parameters:

definition - CalendarDefinition to be persisted

getCalendarDefinition

CalendarDefinition getCalendarDefinition(Long id)

Retrieve a calendar definition.

Parameters:

id - ID of the calendar definition to be retrieved

Returns:

getCalendarDefinition

CalendarDefinition getCalendarDefinition(String fname)

getPredefinedCalendarDefinitions

List<PredefinedCalendarDefinition> getPredefinedCalendarDefinitions()

Retrieves all pre-defined calendar definition

Returns:

getPredefinedCalendarDefinitionByName

PredefinedCalendarDefinition getPredefinedCalendarDefinitionByName(String name)

Retrieve a pre-defined calendar definition based on the name field.

Parameters:

name - Name of the calendar definition to be retrieved

Returns:

getPredefinedCalendarDefinition

PredefinedCalendarDefinition getPredefinedCalendarDefinition(Long id)

Retrieve a pre-defined calendar definition

Parameters:

id - ID of the calendar definition to be retrieved

Returns:

storeCalendarConfiguration

void storeCalendarConfiguration(CalendarConfiguration configuration)

Save or update a calendar configuration.

Parameters:

configuration - CalendarConfiguration to be persisted

getCalendarConfiguration

CalendarConfiguration getCalendarConfiguration(Long id)

Retrieve a calendar configuration.

Parameters:

id - ID of the calendar configuration to be retrieved

Returns:

getCalendarConfigurations

List<UserDefinedCalendarConfiguration> getCalendarConfigurations(String subscribeId)

Retrieve a list of calendar configurations for the specified portlet.

Parameters:

subscribeId - unique ID for this portlet subscription

Returns:

getUserDefinedCalendarConfiguration

UserDefinedCalendarConfiguration getUserDefinedCalendarConfiguration(String subscribeId,
                                                                     String name)

Retrieve a list of all user-defined calendar configurations.

Parameters:

subscribeId - Unique ID for this portlet subscription

name - Name of the desired calendar

Returns:

getUserDefinedCalendarConfigurations

List<UserDefinedCalendarConfiguration> getUserDefinedCalendarConfigurations()

Retrieve a list of all user-defined calendar configurations.

Returns:

getUserDefinedCalendarConfigurations

List<UserDefinedCalendarConfiguration> getUserDefinedCalendarConfigurations(String subscribeId,
                                                                            boolean visibleOnly)

Retrieve a list of user-defined calendar configurations for the specified portlet.

Parameters:

subscribeId - unique ID for this portlet subscription

visibleOnly - true to retrieve only non-hidden calendar configurations, false otherwise

Returns:

getPredefinedCalendarConfigurations

List<PredefinedCalendarConfiguration> getPredefinedCalendarConfigurations(String subscribeId,
                                                                          boolean visibleOnly)

Retrieve a list of pre-defined calendar configurations for the specified portlet.

Parameters:

subscribeId - unique ID for this portlet subscription

visibleOnly - true to retrieve only non-hidden calendar configurations, false otherwise

Returns:

getPredefinedCalendarConfiguration

PredefinedCalendarConfiguration getPredefinedCalendarConfiguration(String subscribeId,
                                                                   String name)

Retrieve a PredefinedCalendarConfiguration for the specified subscribeId and name.

Parameters:

subscribeId - unique ID for this portlet subscription

name - Name of the corresponding PredefinedCalendarDefinition

Returns:

getPredefinedCalendarConfigurations

List<PredefinedCalendarConfiguration> getPredefinedCalendarConfigurations()

Retrieve a list of all pre-defined calendar configurations.

Returns:

deleteCalendarConfiguration

void deleteCalendarConfiguration(CalendarConfiguration configuration)

Remove a calendar configuration from the data store

Parameters:

configuration - configuration to be removed

deleteCalendarDefinition

void deleteCalendarDefinition(CalendarDefinition definition)

Remove a calendar definition from the data store.

Parameters:

definition - definition to be removed

initCalendar

void initCalendar(String subscribeId,
                  Set<String> roles)

Initialize calendar subscriptions for a given portlet subscription and role.

Parameters:

subscribeId - unique ID for this portlet subscription

roles - user roles to use to find default calendars

getHiddenPredefinedCalendarDefinitions

List<PredefinedCalendarDefinition> getHiddenPredefinedCalendarDefinitions(String subscribeId,
                                                                          Set<String> role)

Retrieve a list of hidden predefined calendars for this portlet subscription and role.

Parameters:

subscribeId - unique ID for this portlet subscription

role - user role to use to find default calendars

Returns:

getUserRoles

List<String> getUserRoles()

Get a list of all user roles currently in use.

Returns: