com.webmethods.sc.calendar

Interface ICalendarManager

public interface ICalendarManager

Calendar Manager implements calendar objects persistance

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteCalendar(String calendarID) Deletes a calendar for given calendar ID.
ICalendar	getCalendarByAlias(String alias) Returns calendar object by its alias.
ICalendar	getCalendarByID(String calendarID) Returns calendar object by its ID.
String	getDefaultCalendarID() Returns system default calendar ID.
List	listCalendars(String location) Returns list of ICalendar objects stored in the specified location
void	setDefaultCalendarID(String calendarID) Sets system default calendar ID
void	storeCalendar(String location, ICalendar calendar) Stores specified calendar object at the specified location folder.

Method Detail

getCalendarByID

ICalendar getCalendarByID(String calendarID)
                          throws CalendarException

Returns calendar object by its ID. Returns null of no calendar is found for specified calendar ID

Parameters:

calendarID -

Returns:

ICalendar object for specified ID or null

Throws:

CalendarException

getCalendarByAlias

ICalendar getCalendarByAlias(String alias)
                             throws CalendarException

Returns calendar object by its alias. Returns null of no calendar is found for specified calendar alias

Parameters:

alias - calendar alias value

Returns:

ICalendar object for specified alias or null

Throws:

CalendarException

listCalendars

List listCalendars(String location)
                   throws CalendarException

Returns list of ICalendar objects stored in the specified location

Parameters:

location - ID or alias of the storage folder for calendars

Returns:

List of ICalendar objects

Throws:

CalendarException

deleteCalendar

void deleteCalendar(String calendarID)
                    throws CalendarException

Deletes a calendar for given calendar ID. Does nothing if calendar ID is invalid of calendar with specified ID was already deleted

Parameters:

calendarID -

Throws:

CalendarException

storeCalendar

void storeCalendar(String location,
                 ICalendar calendar)
                   throws CalendarException

Stores specified calendar object at the specified location folder. This operation could be used to store new calendar object (new auto-generated calendar ID will be assigned to these) or update existing calendars

Parameters:

location - ID or alias of the folder to store calendar at

calendar - calendar object to store. If this is a new calendar then its ID will be populated with valid value

Throws:

CalendarException

getDefaultCalendarID

String getDefaultCalendarID()
                            throws CalendarException

Returns system default calendar ID. Null if not defined

Returns:

calendar ID or null

Throws:

CalendarException

setDefaultCalendarID

void setDefaultCalendarID(String calendarID)
                          throws CalendarException

Sets system default calendar ID

Parameters:

calendarID - calendar ID

Throws:

CalendarException