org.osid.calendaring

Interface CalendaringManager

All Superinterfaces:

java.lang.AutoCloseable, CalendaringProfile, java.io.Closeable, OsidManager, OsidProfile, Sourceable

public interface CalendaringManager
extends OsidManager, CalendaringProfile

The calendaring manager provides access to calendaring sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

• EventLookupSession: a session to look up events
• EventQuerySession: a session to query events
• EventSearchSession: a session to search events
• EventAdminSession: a session to manage events
• EventNotificationSession: a session to receive messages pertaining to event changes
• EventCalendarSession: a session for retriieving event and calendar mappings
• EventCalendarAssignmentSession: a session for managing event and calendar mappings
• EventSmartCalendarSession: a session to manage dynamic event catalogs
• RecurringEventLookupSession: a session to look up recurring events
• RecurringEventQuerySession: a session to query recurring events
• RecurringEventSearchSession: a session to search recurring events
• RecurringEventAdminSession: a session to create, modify and delete recurring event
• RecurringEventNotificationSession: a session to receive messages pertaining to recurring event changes
• RecurringEventCalendarSession: a session for retriieving recurring event and calendar mappings
• RecurringEventCalendarAssignmentSession: a session for managing recurring event and calendar mappings
• RecurringEventSmartCalendarSession: a session to manage dynamic recurring event catalogs

• SupersedingEventLookupSession: a session to look up superseding events
• SupersedingEventQuerySession: a session to query superseding events
• SupersedingEventSearchSession: a session to search superseding events
• SupersedingEventAdminSession: a session to create, modify and delete superseding events
• SupersedingEventNotificationSession: a session to receive messages pertaining to superseding event changes
• SupersedingEventCalendarSession: a session for retriieving superseding event and calendar mappings
• SupersedingEventCalendarAssignmentSession: a session for managing superseding event and calendar mappings
• SupersedingEventSmartCalendarSession: a session to manage dynamic superseding event catalogs
• OffsetEventLookupSession: a session to look up offset events
• OffsetEventQuerySession: a session to query offset events
• OffsetEventSearchSession: a session to search offset events
• OffsetEventAdminSession: a session to create, modify and delete offset events
• OffsetEventNotificationSession: a session to receive messages pertaining to offset event changes
• OffsetEventCalendarSession: a session for retriieving offset event and calendar mappings
• OffsetEventCalendarAssignmentSession: a session for managing offset event and calendar mappings
• OffsetEventSmartCalendarSession: a session to manage dynamic offset event catalogs

• ScheduleLookupSession: a session to look up schedules
• ScheduleQuerySession: a session to query schedules
• ScheduleSearchSession: a session to search schedules
• ScheduleAdminSession: a session to create, modify and delete schedules
• ScheduleNotificationSession: a session to receive messages pertaining to schedule changes
• ScheduleCalendarSession: a session for retriieving schedule and calendar mappings
• ScheduleCalendarAssignmentSession: a session for managing schedule and calendar mappings
• ScheduleSmartCalendarSession: a session to manage dynamic schedule catalogs
• ScheduleSlotLookupSession: a session to look up schedule slots
• ScheduleSlotQuerySession: a session to query schedule slots
• ScheduleSlotSearchSession: a session to search scheduls slots
• ScheduleSlotAdminSession: a session to create, modify and delete schedule slots
• ScheduleSlotNotificationSession: a session to receive messages pertaining to schedule slot changes
• ScheduleSlotCalendarSession: a session for retriieving schedule slot and calendar mappings
• ScheduleSlotCalendarAssignmentSession: a session for managing schedule slot and calendar mappings
• ScheduleSlotSmartCalendarSession: a session to manage dynamic schedule slot catalogs

• CommitmentLookupSession: a session to look up commitments
• CommitmentQuerySession: a session to query commitments
• CommitmentSearchSession: a session to search commitments
• CommitmentAdminSession: a session to create, modify and delete commitments
• CommitmentNotificationSession: a session to receive messages pertaining to commitment changes
• CommitmentCalendarSession: a session for retriieving commitment and calendar mappings
• CommitmentCalendarAssignmentSession: a session for managing commitment and calendar mappings
• CommitmentSmartCalendarSession: a session to manage dynamic commitment catalogs

• TimePeriodLookupSession: a session to look up time periods
• TimePeriodQuerySession: a session to query time periods
• TimePeriodSearchSession: a session to search time periods
• TimePeriodAdminSession: a session to create, modify and delete time periods
• TimePeriodNotificationSession: a session to receive messages pertaining to time period changes
• TimePeriodCalendarSession: a session for retriieving time period and calendar mappings
• TimePeriodCalendarAssignmentSession: a session for managing time period and calendar mappings
• TimePeriodSmartCalendarSession: a session to manage dynamic time period catalogs

• CalendarLookupSession: a session to lookup calendars
• CalendarSearchSession : a session to search calendars
• CalendarAdminSession : a session to create, modify and delete calendars
• CalendarNotificationSession : a session to receive messages pertaining to calendar changes
• CalendarHierarchySession: a session to traverse the calendar hierarchy
• CalendarHierarchyDesignSession: a session to manage the calendar hierarchy

Method Summary

Methods

Modifier and Type	Method and Description
CalendaringBatchManager	getCalandaringBatchManager() Gets the calendaring batch manager.
CalendaringCycleManager	getCalandaringCycleManager() Gets the calendaring cycle manager.
CalendaringRulesManager	getCalandaringRulesManager() Gets the calendaring rules manager.
CalendarAdminSession	getCalendarAdminSession() Gets the OsidSession associated with the calendar administration service.
CalendarHierarchyDesignSession	getCalendarHierarchyDesignSession() Gets the session designing calendar hierarchies.
CalendarHierarchySession	getCalendarHierarchySession() Gets the session traversing calendar hierarchies.
CalendarLookupSession	getCalendarLookupSession() Gets the OsidSession associated with the calendar lookup service.
CalendarNotificationSession	getCalendarNotificationSession(CalendarReceiver calendarReceiver) Gets the notification session for notifications pertaining to calendar service changes.
CalendarSearchSession	getCalendarSearchSession() Gets the OsidSession associated with the calendar search service.
CommitmentAdminSession	getCommitmentAdminSession() Gets the OsidSession associated with the commitment administration service.
CommitmentAdminSession	getCommitmentAdminSessionForCalendar(Id calendarId) Gets the OsidSession associated with the commitment admin service for the given calendar.
CommitmentCalendarAssignmentSession	getCommitmentCalendarAssignmentSession() Gets the session for assigning commitment to calendar mappings.
CommitmentCalendarSession	getCommitmentCalendarSession() Gets the session for retrieving commitment to calendar mappings.
CommitmentLookupSession	getCommitmentLookupSession() Gets the OsidSession associated with the commitment lookup service.
CommitmentLookupSession	getCommitmentLookupSessionForCalendar(Id calendarId) Gets the OsidSession associated with the commitment lookup service for the given calendar.
CommitmentNotificationSession	getCommitmentNotificationSession(CommitmentReceiver commitmentReceiver) Gets the notification session for notifications pertaining to commitment changes.
CommitmentNotificationSession	getCommitmentNotificationSessionForCalendar(CommitmentReceiver commitmentReceiver, Id calendarId) Gets the OsidSession associated with the commitment notification service for the given calendar.
CommitmentQuerySession	getCommitmentQuerySession() Gets the OsidSession associated with the commitment query service.
CommitmentQuerySession	getCommitmentQuerySessionForCalendar(Id calendarId) Gets the OsidSession associated with the commitment query service for the given calendar.
CommitmentSearchSession	getCommitmentSearchSession() Gets the OsidSession associated with the commitment search service.
CommitmentSearchSession	getCommitmentSearchSessionForCalendar(Id calendarId) Gets the OsidSession associated with the commitment search service for the given calendar.
CommitmentSmartCalendarSession	getCommitmentSmartCalendarSession(Id calendarId) Gets the session associated with the commitment smart calendar for the given calendar.
EventAdminSession	getEventAdminSession() Gets the OsidSession associated with the event administration service.
EventAdminSession	getEventAdminSessionForCalendar(Id calendarId) Gets the OsidSession associated with the event admin service for the given calendar.
EventCalendarAssignmentSession	getEventCalendarAssignmentSession() Gets the session for assigning event to calendar mappings.
EventCalendarSession	getEventCalendarSession() Gets the session for retrieving event to calendar mappings.
EventLookupSession	getEventLookupSession() Gets the OsidSession associated with the event lookup service.
EventLookupSession	getEventLookupSessionForCalendar(Id calendarId) Gets the OsidSession associated with the event lookup service for the given calendar.
EventNotificationSession	getEventNotificationSession(EventReceiver eventReceiver) Gets the notification session for notifications pertaining to event changes.
EventNotificationSession	getEventNotificationSessionForCalendar(EventReceiver eventReceiver, Id calendarId) Gets the OsidSession associated with the event notification service for the given calendar.
EventQuerySession	getEventQuerySession() Gets the OsidSession associated with the event query service.
EventQuerySession	getEventQuerySessionForCalendar(Id calendarId) Gets the OsidSession associated with the event query service for the given calendar.
EventSearchSession	getEventSearchSession() Gets the OsidSession associated with the event search service.
EventSearchSession	getEventSearchSessionForCalendar(Id calendarId) Gets the OsidSession associated with the event search service for the given calendar.
EventSmartCalendarSession	getEventSmartCalendarSession(Id calendarId) Gets the session associated with the event smart calendar for the given calendar.
OffsetEventAdminSession	getOffsetEventAdminSession() Gets the OsidSession associated with the offset event administration service.
OffsetEventAdminSession	getOffsetEventAdminSessionForCalendar(Id calendarId) Gets the OsidSession associated with the offset event admin service for the given calendar.
OffsetEventCalendarAssignmentSession	getOffsetEventCalendarAssignmentSession() Gets the session for assigning offset event to calendar mappings.
OffsetEventCalendarSession	getOffsetEventCalendarSession() Gets the session for retrieving offset event to calendar mappings.
OffsetEventLookupSession	getOffsetEventLookupSession() Gets the OsidSession associated with the offset event lookup service.
OffsetEventLookupSession	getOffsetEventLookupSessionForCalendar(Id calendarId) Gets the OsidSession associated with the offset event lookup service for the given calendar.
OffsetEventNotificationSession	getOffsetEventNotificationSession(OffsetEventReceiver offsetEventReceiver) Gets the notification session for notifications pertaining to offset event changes.
OffsetEventNotificationSession	getOffsetEventNotificationSessionForCalendar(OffsetEventReceiver offsetEventReceiver, Id calendarId) Gets the OsidSession associated with the offset event notification service for the given calendar.
OffsetEventQuerySession	getOffsetEventQuerySession() Gets the OsidSession associated with the offset event query service.
OffsetEventQuerySession	getOffsetEventQuerySessionForCalendar(Id calendarId) Gets the OsidSession associated with the offset event query service for the given calendar.
OffsetEventSearchSession	getOffsetEventSearchSession() Gets the OsidSession associated with the offset event search service.
OffsetEventSearchSession	getOffsetEventSearchSessionForCalendar(Id calendarId) Gets the OsidSession associated with the offset event search service for the given calendar.
OffsetEventSmartCalendarSession	getOffsetEventSmartCalendarSession(Id calendarId) Gets the session associated with the offset event smart calendar for the given calendar.
RecurringEventAdminSession	getRecurringEventAdminSession() Gets the OsidSession associated with the recurring event administration service.
RecurringEventAdminSession	getRecurringEventAdminSessionForCalendar(Id calendarId) Gets the OsidSession associated with the recurring event admin service for the given calendar.
RecurringEventCalendarAssignmentSession	getRecurringEventCalendarAssignmentSession() Gets the session for assigning recurring event to calendar mappings.
RecurringEventCalendarSession	getRecurringEventCalendarSession() Gets the session for retrieving recurring event to calendar mappings.
RecurringEventLookupSession	getRecurringEventLookupSession() Gets the OsidSession associated with the recurring event lookup service.
RecurringEventLookupSession	getRecurringEventLookupSessionForCalendar(Id calendarId) Gets the OsidSession associated with the recurring event lookup service for the given calendar.
RecurringEventNotificationSession	getRecurringEventNotificationSession(RecurringEventReceiver recurringEventReceiver) Gets the notification session for notifications pertaining to recurring event changes.
RecurringEventNotificationSession	getRecurringEventNotificationSessionForCalendar(RecurringEventReceiver recurringEventReceiver, Id calendarId) Gets the OsidSession associated with the recurring event notification service for the given calendar.
RecurringEventQuerySession	getRecurringEventQuerySession() Gets the OsidSession associated with the recurring event query service.
RecurringEventQuerySession	getRecurringEventQuerySessionForCalendar(Id calendarId) Gets the OsidSession associated with the recurring event query service for the given calendar.
RecurringEventSearchSession	getRecurringEventSearchSession() Gets the OsidSession associated with the recurring event search service.
RecurringEventSearchSession	getRecurringEventSearchSessionForCalendar(Id calendarId) Gets the OsidSession associated with the recurring event search service for the given calendar.
RecurringEventSmartCalendarSession	getRecurringEventSmartCalendarSession(Id calendarId) Gets the session associated with the recurring event smart calendar for the given calendar.
ScheduleAdminSession	getScheduleAdminSession() Gets the OsidSession associated with the schedule administration service.
ScheduleAdminSession	getScheduleAdminSessionForCalendar(Id calendarId) Gets the OsidSession associated with the schedule admin service for the given calendar.
ScheduleCalendarAssignmentSession	getScheduleCalendarAssignmentSession() Gets the session for assigning schedule to calendar mappings.
ScheduleCalendarSession	getScheduleCalendarSession() Gets the session for retrieving schedule to calendar mappings.
ScheduleLookupSession	getScheduleLookupSession() Gets the OsidSession associated with the schedule lookup service.
ScheduleLookupSession	getScheduleLookupSessionForCalendar(Id calendarId) Gets the OsidSession associated with the schedule lookup service for the given calendar.
ScheduleNotificationSession	getScheduleNotificationSession(ScheduleReceiver scheduleReceiver) Gets the notification session for notifications pertaining to schedule changes.
ScheduleNotificationSession	getScheduleNotificationSessionForCalendar(ScheduleReceiver scheduleReceiver, Id calendarId) Gets the OsidSession associated with the schedule notification service for the given calendar.
ScheduleQuerySession	getScheduleQuerySession() Gets the OsidSession associated with the schedule query service.
ScheduleQuerySession	getScheduleQuerySessionForCalendar(Id calendarId) Gets the OsidSession associated with the schedule query service for the given calendar.
ScheduleSearchSession	getScheduleSearchSession() Gets the OsidSession associated with the schedule search service.
ScheduleSearchSession	getScheduleSearchSessionForCalendar(Id calendarId) Gets the OsidSession associated with the schedule search service for the given calendar.
ScheduleSlotAdminSession	getScheduleSlotAdminSession() Gets the OsidSession associated with the schedule slot administration service.
ScheduleSlotAdminSession	getScheduleSlotAdminSessionForCalendar(Id calendarId) Gets the OsidSession associated with the schedule slot admin service for the given calendar.
ScheduleSlotCalendarAssignmentSession	getScheduleSlotCalendarAssignmentSession() Gets the session for assigning schedule slot to calendar mappings.
ScheduleSlotCalendarSession	getScheduleSlotCalendarSession() Gets the session for retrieving schedule slot to calendar mappings.
ScheduleSlotLookupSession	getScheduleSlotLookupSession() Gets the OsidSession associated with the schedule slot lookup service.
ScheduleSlotLookupSession	getScheduleSlotLookupSessionForCalendar(Id calendarId) Gets the OsidSession associated with the schedule slot lookup service for the given calendar.
ScheduleSlotNotificationSession	getScheduleSlotNotificationSession(ScheduleSlotReceiver scheduleSlotReceiver) Gets the notification session for notifications pertaining to schedule slot changes.
ScheduleSlotNotificationSession	getScheduleSlotNotificationSessionForCalendar(ScheduleSlotReceiver scheduleSlotReceiver, Id calendarId) Gets the OsidSession associated with the schedule slot notification service for the given calendar.
ScheduleSlotQuerySession	getScheduleSlotQuerySession() Gets the OsidSession associated with the schedule slot query service.
ScheduleSlotQuerySession	getScheduleSlotQuerySessionForCalendar(Id calendarId) Gets the OsidSession associated with the schedule slot query service for the given calendar.
ScheduleSlotSearchSession	getScheduleSlotSearchSession() Gets the OsidSession associated with the schedule slot search service.
ScheduleSlotSearchSession	getScheduleSlotSearchSessionForCalendar(Id calendarId) Gets the OsidSession associated with the schedule slot search service for the given calendar.
ScheduleSlotSmartCalendarSession	getScheduleSlotSmartCalendarSession(Id calendarId) Gets the session associated with the schedule slot smart calendar for the given calendar.
ScheduleSmartCalendarSession	getScheduleSmartCalendarSession(Id calendarId) Gets the session associated with the schedule smart calendar for the given calendar.
SupersedingEventAdminSession	getSupersedingEventAdminSession() Gets the OsidSession associated with the superseding event administration service.
SupersedingEventAdminSession	getSupersedingEventAdminSessionForCalendar(Id calendarId) Gets the OsidSession associated with the superseding event admin service for the given calendar.
SupersedingEventCalendarAssignmentSession	getSupersedingEventCalendarAssignmentSession() Gets the session for assigning superseding event to calendar mappings.
SupersedingEventCalendarSession	getSupersedingEventCalendarSession() Gets the session for retrieving superseding event to calendar mappings.
SupersedingEventLookupSession	getSupersedingEventLookupSession() Gets the OsidSession associated with the superseding event lookup service.
SupersedingEventLookupSession	getSupersedingEventLookupSessionForCalendar(Id calendarId) Gets the OsidSession associated with the superseding event lookup service for the given calendar.
SupersedingEventNotificationSession	getSupersedingEventNotificationSession(SupersedingEventReceiver supersedingEventReceiver) Gets the notification session for notifications pertaining to superseding event changes.
SupersedingEventNotificationSession	getSupersedingEventNotificationSessionForCalendar(SupersedingEventReceiver supersedingEventReceiver, Id calendarId) Gets the OsidSession associated with the superseding event notification service for the given calendar.
SupersedingEventQuerySession	getSupersedingEventQuerySession() Gets the OsidSession associated with the superseding event query service.
SupersedingEventQuerySession	getSupersedingEventQuerySessionForCalendar(Id calendarId) Gets the OsidSession associated with the superseding event query service for the given calendar.
SupersedingEventSearchSession	getSupersedingEventSearchSession() Gets the OsidSession associated with the superseding event search service.
SupersedingEventSearchSession	getSupersedingEventSearchSessionForCalendar(Id calendarId) Gets the OsidSession associated with the superseding event search service for the given calendar.
SupersedingEventSmartCalendarSession	getSupersedingEventSmartCalendarSession(Id calendarId) Gets the session associated with the superseding event smart calendar for the given calendar.
TimePeriodAdminSession	getTimePeriodAdminSession() Gets the OsidSession associated with the time period administration service.
TimePeriodAdminSession	getTimePeriodAdminSessionForCalendar(Id calendarId) Gets the OsidSession associated with the time period admin service for the given calendar.
TimePeriodCalendarAssignmentSession	getTimePeriodCalendarAssignmentSession() Gets the session for assigning time period to calendar mappings.
TimePeriodCalendarSession	getTimePeriodCalendarSession() Gets the session for retrieving time period to calendar mappings.
TimePeriodLookupSession	getTimePeriodLookupSession() Gets the OsidSession associated with the time period lookup service.
TimePeriodLookupSession	getTimePeriodLookupSessionForCalendar(Id calendarId) Gets the OsidSession associated with the time period lookup service for the given calendar.
TimePeriodNotificationSession	getTimePeriodNotificationSession(TimePeriodReceiver timePeriodReceiver) Gets the notification session for notifications pertaining to time period changes.
TimePeriodNotificationSession	getTimePeriodNotificationSessionForCalendar(TimePeriodReceiver timePeriodReceiver, Id calendarId) Gets the OsidSession associated with the time period notification service for the given calendar.
TimePeriodQuerySession	getTimePeriodQuerySession() Gets the OsidSession associated with the time period query service.
TimePeriodQuerySession	getTimePeriodQuerySessionForCalendar(Id calendarId) Gets the OsidSession associated with the time period query service for the given calendar.
TimePeriodSearchSession	getTimePeriodSearchSession() Gets the OsidSession associated with the time period search service.
TimePeriodSearchSession	getTimePeriodSearchSessionForCalendar(Id calendarId) Gets the OsidSession associated with the time period search service for the given calendar.
TimePeriodSmartCalendarSession	getTimePeriodSmartCalendarSession(Id calendarId) Gets the session associated with the time period smart calendar for the given calendar.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.calendaring.CalendaringProfile

getCalendarRecordTypes, getCalendarSearchRecordTypes, getCommitmentRecordTypes, getCommitmentSearchRecordTypes, getCoordinateRecordTypes, getEventRecordTypes, getEventSearchRecordTypes, getOffsetEventRecordTypes, getOffsetEventSearchRecordTypes, getRecurringEventRecordTypes, getRecurringEventSearchRecordTypes, getScheduleRecordTypes, getScheduleSearchRecordTypes, getScheduleSlotRecordTypes, getScheduleSlotSearchRecordTypes, getSpatialUnitRecordTypes, getSupersedingEventRecordTypes, getSupersedingEventSearchRecordTypes, getTimePeriodRecordTypes, getTimePeriodSearchRecordTypes, supportsCalendarAdmin, supportsCalendarHierarchy, supportsCalendarHierarchyDesign, supportsCalendaringBatch, supportsCalendaringCycle, supportsCalendaringRules, supportsCalendarLookup, supportsCalendarNotification, supportsCalendarRecordType, supportsCalendarSearch, supportsCalendarSearchRecordType, supportsCommitmentAdmin, supportsCommitmentCalendar, supportsCommitmentCalendarAssignment, supportsCommitmentLookup, supportsCommitmentNotification, supportsCommitmentQuery, supportsCommitmentRecordType, supportsCommitmentSearch, supportsCommitmentSearchRecordType, supportsCommitmentSmartCalendar, supportsCoordinateRecordType, supportsEventAdmin, supportsEventCalendar, supportsEventCalendarAssignment, supportsEventLookup, supportsEventNotification, supportsEventQuery, supportsEventRecordType, supportsEventSearch, supportsEventSearchRecordType, supportsEventSmartCalendar, supportsOffsetEventAdmin, supportsOffsetEventCalendar, supportsOffsetEventCalendarAssignment, supportsOffsetEventLookup, supportsOffsetEventNotification, supportsOffsetEventQuery, supportsOffsetEventRecordType, supportsOffsetEventSearch, supportsOffsetEventSearchRecordType, supportsOffsetEventSmartCalendar, supportsRecurringEventAdmin, supportsRecurringEventCalendar, supportsRecurringEventCalendarAssignment, supportsRecurringEventLookup, supportsRecurringEventNotification, supportsRecurringEventQuery, supportsRecurringEventRecordType, supportsRecurringEventSearch, supportsRecurringEventSearchRecordType, supportsRecurringEventSmartCalendar, supportsRecurringEventUnravelling, supportsScheduleAdmin, supportsScheduleCalendar, supportsScheduleCalendarAssignment, supportsScheduleLookup, supportsScheduleNotification, supportsScheduleQuery, supportsScheduleRecordType, supportsScheduleSearch, supportsScheduleSearchRecordType, supportsScheduleSlotAdmin, supportsScheduleSlotCalendar, supportsScheduleSlotCalendarAssignment, supportsScheduleSlotLookup, supportsScheduleSlotNotification, supportsScheduleSlotQuery, supportsScheduleSlotRecordType, supportsScheduleSlotSearch, supportsScheduleSlotSearchRecordType, supportsScheduleSlotSmartCalendar, supportsScheduleSmartCalendar, supportsSpatialUnitRecordType, supportsSupersedingEventAdmin, supportsSupersedingEventCalendar, supportsSupersedingEventCalendarAssignment, supportsSupersedingEventLookup, supportsSupersedingEventNotification, supportsSupersedingEventQuery, supportsSupersedingEventRecordType, supportsSupersedingEventSearch, supportsSupersedingEventSearchRecordType, supportsSupersedingEventSmartCalendar, supportsTimePeriodAdmin, supportsTimePeriodCalendar, supportsTimePeriodCalendarAssignment, supportsTimePeriodLookup, supportsTimePeriodNotification, supportsTimePeriodRecordType, supportsTimePeriodSearch, supportsTimePeriodSearchRecordType, supportsTimePeriodSmartCalendar, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getEventLookupSession

EventLookupSession getEventLookupSession()
                                         throws OperationFailedException

Gets the OsidSession associated with the event lookup service.

Returns:

an EventLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEventLookup() is false

Compliance:

optional - This method must be implemented if supportsEventLookup() is true.

getEventLookupSessionForCalendar

EventLookupSession getEventLookupSessionForCalendar(Id calendarId)
                                                    throws NotFoundException,
                                                           OperationFailedException

Gets the OsidSession associated with the event lookup service for the given calendar.

Parameters:

calendarId - the Id of the calendar

Returns:

an EventLookupSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEventLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsEventLookup() and supportsVisibleFederation() are true.

getEventQuerySession

EventQuerySession getEventQuerySession()
                                       throws OperationFailedException

Gets the OsidSession associated with the event query service.

Returns:

an EventQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEventQuery() is false

Compliance:

optional - This method must be implemented if supportsEventQuery() is true.

getEventQuerySessionForCalendar

EventQuerySession getEventQuerySessionForCalendar(Id calendarId)
                                                  throws NotFoundException,
                                                         OperationFailedException

Gets the OsidSession associated with the event query service for the given calendar.

Parameters:

calendarId - the Id of the calendar

Returns:

an EventQuerySession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEventQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsEventQuery() and supportsVisibleFederation() are true.

getEventSearchSession

EventSearchSession getEventSearchSession()
                                         throws OperationFailedException

Gets the OsidSession associated with the event search service.

Returns:

an EventSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEventSearch() is false

Compliance:

optional - This method must be implemented if supportsEventSearch() is true.

getEventSearchSessionForCalendar

EventSearchSession getEventSearchSessionForCalendar(Id calendarId)
                                                    throws NotFoundException,
                                                           OperationFailedException

Gets the OsidSession associated with the event search service for the given calendar.

Parameters:

calendarId - the Id of the calendar

Returns:

an EventSearchSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEventSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsEventSearch() and supportsVisibleFederation() are true.

getEventAdminSession

EventAdminSession getEventAdminSession()
                                       throws OperationFailedException

Gets the OsidSession associated with the event administration service.

Returns:

an EventAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEventAdmin() is false

Compliance:

optional - This method must be implemented if supportsEventAdmin() is true.

getEventAdminSessionForCalendar

EventAdminSession getEventAdminSessionForCalendar(Id calendarId)
                                                  throws NotFoundException,
                                                         OperationFailedException

Gets the OsidSession associated with the event admin service for the given calendar.

Parameters:

calendarId - the Id of the calendar

Returns:

an EventAdminSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEventAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsEventAdmin() and supportsVisibleFederation() are true.

getEventNotificationSession

EventNotificationSession getEventNotificationSession(EventReceiver eventReceiver)
                                                     throws OperationFailedException

Gets the notification session for notifications pertaining to event changes.

Parameters:

eventReceiver - the event receiver

Returns:

an EventNotificationSession

Throws:

NullArgumentException - eventReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEventNotification() is false

Compliance:

optional - This method must be implemented if supportsEventNotification() is true.

getEventNotificationSessionForCalendar

EventNotificationSession getEventNotificationSessionForCalendar(EventReceiver eventReceiver,
                                                              Id calendarId)
                                                                throws NotFoundException,
                                                                       OperationFailedException

Gets the OsidSession associated with the event notification service for the given calendar.

Parameters:

eventReceiver - the event receiver

calendarId - the Id of the calendar

Returns:

an EventNotificationSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - eventReceiver or calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEventNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsEventNotification() and supportsVisibleFederation() are true.

getEventCalendarSession

EventCalendarSession getEventCalendarSession()
                                             throws OperationFailedException

Gets the session for retrieving event to calendar mappings.

Returns:

an EventCalendarSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEventCalendar() is false

Compliance:

optional - This method must be implemented if supportsEventCalendar() is true.

getEventCalendarAssignmentSession

EventCalendarAssignmentSession getEventCalendarAssignmentSession()
                                                                 throws OperationFailedException

Gets the session for assigning event to calendar mappings.

Returns:

an EventCalendarAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEventCalendarAssignment() is false

Compliance:

optional - This method must be implemented if supportsEventCalendarAssignment() is true.

getEventSmartCalendarSession

EventSmartCalendarSession getEventSmartCalendarSession(Id calendarId)
                                                       throws NotFoundException,
                                                              OperationFailedException

Gets the session associated with the event smart calendar for the given calendar.

Parameters:

calendarId - the Id of the calendar

Returns:

an EventSmartCalendarSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEventSmartCalendar() is false

Compliance:

optional - This method must be implemented if supportsEventSmartCalendar() is true.

getRecurringEventLookupSession

RecurringEventLookupSession getRecurringEventLookupSession()
                                                           throws OperationFailedException

Gets the OsidSession associated with the recurring event lookup service.

Returns:

a RecurringEventLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRecurringEventLookup() is false

Compliance:

optional - This method must be implemented if supportsRecurringEventLookup() is true.

getRecurringEventLookupSessionForCalendar

RecurringEventLookupSession getRecurringEventLookupSessionForCalendar(Id calendarId)
                                                                      throws NotFoundException,
                                                                             OperationFailedException

Gets the OsidSession associated with the recurring event lookup service for the given calendar.

Parameters:

calendarId - the Id of the calendar

Returns:

a RecurringEventLookupSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRecurringEventLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsRecurringEventLookup() and supportsVisibleFederation() are true.

getRecurringEventQuerySession

RecurringEventQuerySession getRecurringEventQuerySession()
                                                         throws OperationFailedException

Gets the OsidSession associated with the recurring event query service.

Returns:

a RecurringEventQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRecurringEventQuery() is false

Compliance:

optional - This method must be implemented if supportsRecurringEventQuery() is true.

getRecurringEventQuerySessionForCalendar

RecurringEventQuerySession getRecurringEventQuerySessionForCalendar(Id calendarId)
                                                                    throws NotFoundException,
                                                                           OperationFailedException

Gets the OsidSession associated with the recurring event query service for the given calendar.

Parameters:

calendarId - the Id of the calendar

Returns:

a RecurringEventQuerySession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRecurringEventQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsRecurringEventQuery() and supportsVisibleFederation() are true.

getRecurringEventSearchSession

RecurringEventSearchSession getRecurringEventSearchSession()
                                                           throws OperationFailedException

Gets the OsidSession associated with the recurring event search service.

Returns:

a RecurringEventSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRecurringEventSearch() is false

Compliance:

optional - This method must be implemented if supportsRecurringEventSearch() is true.

getRecurringEventSearchSessionForCalendar

RecurringEventSearchSession getRecurringEventSearchSessionForCalendar(Id calendarId)
                                                                      throws NotFoundException,
                                                                             OperationFailedException

Gets the OsidSession associated with the recurring event search service for the given calendar.

Parameters:

calendarId - the Id of the calendar

Returns:

a RecurringEventSearchSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRecurringEventSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsRecurringEventSearch() and supportsVisibleFederation() are true.

getRecurringEventAdminSession

RecurringEventAdminSession getRecurringEventAdminSession()
                                                         throws OperationFailedException

Gets the OsidSession associated with the recurring event administration service.

Returns:

a RecurringEventAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRecurringEventAdmin() is false

Compliance:

optional - This method must be implemented if supportsRecurringEventAdmin() is true.

getRecurringEventAdminSessionForCalendar

RecurringEventAdminSession getRecurringEventAdminSessionForCalendar(Id calendarId)
                                                                    throws NotFoundException,
                                                                           OperationFailedException

Gets the OsidSession associated with the recurring event admin service for the given calendar.

Parameters:

calendarId - the Id of the calendar

Returns:

a RecurringEventAdminSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRecurringEventAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsRecurringEventAdmin() and supportsVisibleFederation() are true.

getRecurringEventNotificationSession

RecurringEventNotificationSession getRecurringEventNotificationSession(RecurringEventReceiver recurringEventReceiver)
                                                                       throws OperationFailedException

Gets the notification session for notifications pertaining to recurring event changes.

Parameters:

recurringEventReceiver - the recurring event receiver

Returns:

a RecurringEventNotificationSession

Throws:

NullArgumentException - recurringEventReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRecurringEventNotification() is false

Compliance:

optional - This method must be implemented if supportsRecurringEventNotification() is true.

getRecurringEventNotificationSessionForCalendar

RecurringEventNotificationSession getRecurringEventNotificationSessionForCalendar(RecurringEventReceiver recurringEventReceiver,
                                                                                Id calendarId)
                                                                                  throws NotFoundException,
                                                                                         OperationFailedException

Gets the OsidSession associated with the recurring event notification service for the given calendar.

Parameters:

recurringEventReceiver - the recurring event receiver

calendarId - the Id of the calendar

Returns:

a RecurringEventNotificationSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - recurringEventReceiver or calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRecurringEventNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsRecurringEventNotification() and supportsVisibleFederation() are true.

getRecurringEventCalendarSession

RecurringEventCalendarSession getRecurringEventCalendarSession()
                                                               throws OperationFailedException

Gets the session for retrieving recurring event to calendar mappings.

Returns:

A RecurringEventCalendarSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRecurringEventCalendar() is false

Compliance:

optional - This method must be implemented if supportsRecurringEventCalendar() is true.

getRecurringEventCalendarAssignmentSession

RecurringEventCalendarAssignmentSession getRecurringEventCalendarAssignmentSession()
                                                                                   throws OperationFailedException

Gets the session for assigning recurring event to calendar mappings.

Returns:

a RecurringEventCalendarAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRecurringEventCalendarAssignment() is false

Compliance:

optional - This method must be implemented if supportsRecurringEventCalendarAssignment() is true.

getRecurringEventSmartCalendarSession

RecurringEventSmartCalendarSession getRecurringEventSmartCalendarSession(Id calendarId)
                                                                         throws NotFoundException,
                                                                                OperationFailedException

Gets the session associated with the recurring event smart calendar for the given calendar.

Parameters:

calendarId - the Id of the calendar

Returns:

a RecurringEventSmartCalendarSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRecurringEventSmartCalendar() is false

Compliance:

optional - This method must be implemented if supportsRecurringEventSmartCalendar() is true.

getSupersedingEventLookupSession

SupersedingEventLookupSession getSupersedingEventLookupSession()
                                                               throws OperationFailedException

Gets the OsidSession associated with the superseding event lookup service.

Returns:

a SupersedingEventLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEventLookup() is false

Compliance:

optional - This method must be implemented if supportsSupersedingEventLookup() is true.

getSupersedingEventLookupSessionForCalendar

SupersedingEventLookupSession getSupersedingEventLookupSessionForCalendar(Id calendarId)
                                                                          throws NotFoundException,
                                                                                 OperationFailedException

Gets the OsidSession associated with the superseding event lookup service for the given calendar.

Parameters:

calendarId - the Id of the calendar

Returns:

a SupersedingEventLookupSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSupersedingEventLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsSupersedingEventLookup() and supportsVisibleFederation() are true.

getSupersedingEventQuerySession

SupersedingEventQuerySession getSupersedingEventQuerySession()
                                                             throws OperationFailedException

Gets the OsidSession associated with the superseding event query service.

Returns:

a SupersedingEventQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSupersedingEventQuery() is false

Compliance:

optional - This method must be implemented if supportsSupersedingEventQuery() is true.

getSupersedingEventQuerySessionForCalendar

SupersedingEventQuerySession getSupersedingEventQuerySessionForCalendar(Id calendarId)
                                                                        throws NotFoundException,
                                                                               OperationFailedException

Gets the OsidSession associated with the superseding event query service for the given calendar.

Parameters:

calendarId - the Id of the calendar

Returns:

a SupersedingEventQuerySession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSupersedingEventQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsSupersedingEventQuery() and supportsVisibleFederation() are true.

getSupersedingEventSearchSession

SupersedingEventSearchSession getSupersedingEventSearchSession()
                                                               throws OperationFailedException

Gets the OsidSession associated with the superseding event search service.

Returns:

a SupersedingEventSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEventSearch() is false

Compliance:

optional - This method must be implemented if supportsEventSearch() is true.

getSupersedingEventSearchSessionForCalendar

SupersedingEventSearchSession getSupersedingEventSearchSessionForCalendar(Id calendarId)
                                                                          throws NotFoundException,
                                                                                 OperationFailedException

Gets the OsidSession associated with the superseding event search service for the given calendar.

Parameters:

calendarId - the Id of the calendar

Returns:

a SupersedingEventSearchSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSupersedingEventSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsSupersedingEventSearch() and supportsVisibleFederation() are true.

getSupersedingEventAdminSession

SupersedingEventAdminSession getSupersedingEventAdminSession()
                                                             throws OperationFailedException

Gets the OsidSession associated with the superseding event administration service.

Returns:

a SupersedingEventAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEventAdmin() is false

Compliance:

optional - This method must be implemented if supportsSupersedingEventAdmin() is true.

getSupersedingEventAdminSessionForCalendar

SupersedingEventAdminSession getSupersedingEventAdminSessionForCalendar(Id calendarId)
                                                                        throws NotFoundException,
                                                                               OperationFailedException

Gets the OsidSession associated with the superseding event admin service for the given calendar.

Parameters:

calendarId - the Id of the calendar

Returns:

a SupersedingEventAdminSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSupersedingEventAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsSupersedingEventAdmin() and supportsVisibleFederation() are true.

getSupersedingEventNotificationSession

SupersedingEventNotificationSession getSupersedingEventNotificationSession(SupersedingEventReceiver supersedingEventReceiver)
                                                                           throws OperationFailedException

Gets the notification session for notifications pertaining to superseding event changes.

Parameters:

supersedingEventReceiver - the superseding event receiver

Returns:

a SupersedingEventNotificationSession

Throws:

NullArgumentException - supersedingEventReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSupersedingEventNotification() is false

Compliance:

optional - This method must be implemented if supportsSupersedingEventNotification() is true.

getSupersedingEventNotificationSessionForCalendar

SupersedingEventNotificationSession getSupersedingEventNotificationSessionForCalendar(SupersedingEventReceiver supersedingEventReceiver,
                                                                                    Id calendarId)
                                                                                      throws NotFoundException,
                                                                                             OperationFailedException

Gets the OsidSession associated with the superseding event notification service for the given calendar.

Parameters:

supersedingEventReceiver - the superseding event receiver

calendarId - the Id of the calendar

Returns:

a SupersedingEventNotificationSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - supersedingEventReceiver or calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSupersedingEventNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsSupersedingEventNotification() and supportsVisibleFederation() are true.

getSupersedingEventCalendarSession

SupersedingEventCalendarSession getSupersedingEventCalendarSession()
                                                                   throws OperationFailedException

Gets the session for retrieving superseding event to calendar mappings.

Returns:

a SupersedingEventCalendarSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSupersedingEventCalendar() is false

Compliance:

optional - This method must be implemented if supportsSupersedingEventCalendar() is true.

getSupersedingEventCalendarAssignmentSession

SupersedingEventCalendarAssignmentSession getSupersedingEventCalendarAssignmentSession()
                                                                                       throws OperationFailedException

Gets the session for assigning superseding event to calendar mappings.

Returns:

a SupersedingEventCalendarAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSupersedingEventCalendarAssignment() is false

Compliance:

optional - This method must be implemented if supportsSupersedingEventCalendarAssignment() is true.

getSupersedingEventSmartCalendarSession

SupersedingEventSmartCalendarSession getSupersedingEventSmartCalendarSession(Id calendarId)
                                                                             throws NotFoundException,
                                                                                    OperationFailedException

Gets the session associated with the superseding event smart calendar for the given calendar.

Parameters:

calendarId - the Id of the calendar

Returns:

a SupersedingEventSmartCalendarSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSupersedingEventSmartCalendar() is false

Compliance:

optional - This method must be implemented if supportsSupersedingEventSmartCalendar() is true.

getOffsetEventLookupSession

OffsetEventLookupSession getOffsetEventLookupSession()
                                                     throws OperationFailedException

Gets the OsidSession associated with the offset event lookup service.

Returns:

an OffsetEventLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsOffsetEventLookup() is false

Compliance:

optional - This method must be implemented if supportsOffsetEventLookup() is true.

getOffsetEventLookupSessionForCalendar

OffsetEventLookupSession getOffsetEventLookupSessionForCalendar(Id calendarId)
                                                                throws NotFoundException,
                                                                       OperationFailedException

Gets the OsidSession associated with the offset event lookup service for the given calendar.

Parameters:

calendarId - the Id of the calendar

Returns:

an OffsetEventLookupSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOffsetEventLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsOffsetEventLookup() and supportsVisibleFederation() are true.

getOffsetEventQuerySession

OffsetEventQuerySession getOffsetEventQuerySession()
                                                   throws OperationFailedException

Gets the OsidSession associated with the offset event query service.

Returns:

an OffsetEventQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsOffsetEventQuery() is false

Compliance:

optional - This method must be implemented if supportsOffsetEventQuery() is true.

getOffsetEventQuerySessionForCalendar

OffsetEventQuerySession getOffsetEventQuerySessionForCalendar(Id calendarId)
                                                              throws NotFoundException,
                                                                     OperationFailedException

Gets the OsidSession associated with the offset event query service for the given calendar.

Parameters:

calendarId - the Id of the calendar

Returns:

an OffsetEventQuerySession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOffsetEventQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsOffsetEventQuery() and supportsVisibleFederation() are true.

getOffsetEventSearchSession

OffsetEventSearchSession getOffsetEventSearchSession()
                                                     throws OperationFailedException

Gets the OsidSession associated with the offset event search service.

Returns:

an OffsetEventSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsOffsetEventSearch() is false

Compliance:

optional - This method must be implemented if supportsOffsetEventSearch() is true.

getOffsetEventSearchSessionForCalendar

OffsetEventSearchSession getOffsetEventSearchSessionForCalendar(Id calendarId)
                                                                throws NotFoundException,
                                                                       OperationFailedException

Gets the OsidSession associated with the offset event search service for the given calendar.

Parameters:

calendarId - the Id of the calendar

Returns:

an OffsetEventSearchSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOffsetEventSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsOffsetEventSearch() and supportsVisibleFederation() are true.

getOffsetEventAdminSession

OffsetEventAdminSession getOffsetEventAdminSession()
                                                   throws OperationFailedException

Gets the OsidSession associated with the offset event administration service.

Returns:

an OffsetEventAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsOffsetEventAdmin() is false

Compliance:

optional - This method must be implemented if supportsOffsetEventAdmin() is true.

getOffsetEventAdminSessionForCalendar

OffsetEventAdminSession getOffsetEventAdminSessionForCalendar(Id calendarId)
                                                              throws NotFoundException,
                                                                     OperationFailedException

Gets the OsidSession associated with the offset event admin service for the given calendar.

Parameters:

calendarId - the Id of the calendar

Returns:

an OffsetEventAdminSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOffsetEventAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsOffsetEventAdmin() and supportsVisibleFederation() are true.

getOffsetEventNotificationSession

OffsetEventNotificationSession getOffsetEventNotificationSession(OffsetEventReceiver offsetEventReceiver)
                                                                 throws OperationFailedException

Gets the notification session for notifications pertaining to offset event changes.

Parameters:

offsetEventReceiver - the offset event receiver

Returns:

an OffsetEventNotificationSession

Throws:

NullArgumentException - offsetEventReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOffsetEventNotification() is false

Compliance:

optional - This method must be implemented if supportsOffsetEventNotification() is true.

getOffsetEventNotificationSessionForCalendar

OffsetEventNotificationSession getOffsetEventNotificationSessionForCalendar(OffsetEventReceiver offsetEventReceiver,
                                                                          Id calendarId)
                                                                            throws NotFoundException,
                                                                                   OperationFailedException

Gets the OsidSession associated with the offset event notification service for the given calendar.

Parameters:

offsetEventReceiver - the offset event receiver

calendarId - the Id of the calendar

Returns:

an OffsetEventNotificationSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - offsetEventReceiver or calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOffsetEventNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsOffsetEventNotification() and supportsVisibleFederation() are true.

getOffsetEventCalendarSession

OffsetEventCalendarSession getOffsetEventCalendarSession()
                                                         throws OperationFailedException

Gets the session for retrieving offset event to calendar mappings.

Returns:

an OffsetEventCalendarSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsOffsetEventCalendar() is false

Compliance:

optional - This method must be implemented if supportsOffsetEventCalendar() is true.

getOffsetEventCalendarAssignmentSession

OffsetEventCalendarAssignmentSession getOffsetEventCalendarAssignmentSession()
                                                                             throws OperationFailedException

Gets the session for assigning offset event to calendar mappings.

Returns:

an OffsetEventCalendarAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsOffsetEventCalendarAssignment() is false

Compliance:

optional - This method must be implemented if supportsOffsetEventCalendarAssignment() is true.

getOffsetEventSmartCalendarSession

OffsetEventSmartCalendarSession getOffsetEventSmartCalendarSession(Id calendarId)
                                                                   throws NotFoundException,
                                                                          OperationFailedException

Gets the session associated with the offset event smart calendar for the given calendar.

Parameters:

calendarId - the Id of the calendar

Returns:

an OffsetEventSmartCalendarSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOffsetEventSmartCalendar() is false

Compliance:

optional - This method must be implemented if supportsOffsetEventSmartCalendar() is true.

getScheduleLookupSession

ScheduleLookupSession getScheduleLookupSession()
                                               throws OperationFailedException

Gets the OsidSession associated with the schedule lookup service.

Returns:

a ScheduleLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsScheduleLookup() is false

Compliance:

optional - This method must be implemented if supportsScheduleLookup() is true.

getScheduleLookupSessionForCalendar

ScheduleLookupSession getScheduleLookupSessionForCalendar(Id calendarId)
                                                          throws NotFoundException,
                                                                 OperationFailedException

Gets the OsidSession associated with the schedule lookup service for the given calendar.

Parameters:

calendarId - the Id of the calendar

Returns:

a ScheduleLookupSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsScheduleLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsScheduleLookup() and supportsVisibleFederation() are true.

getScheduleQuerySession

ScheduleQuerySession getScheduleQuerySession()
                                             throws OperationFailedException

Gets the OsidSession associated with the schedule query service.

Returns:

a ScheduleQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsScheduleQuery() is false

Compliance:

optional - This method must be implemented if supportsScheduleQuery() is true.

getScheduleQuerySessionForCalendar

ScheduleQuerySession getScheduleQuerySessionForCalendar(Id calendarId)
                                                        throws NotFoundException,
                                                               OperationFailedException

Gets the OsidSession associated with the schedule query service for the given calendar.

Parameters:

calendarId - the Id of the calendar

Returns:

a ScheduleQuerySession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsScheduleQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsScheduleQuery() and supportsVisibleFederation() are true.

getScheduleSearchSession

ScheduleSearchSession getScheduleSearchSession()
                                               throws OperationFailedException

Gets the OsidSession associated with the schedule search service.

Returns:

a ScheduleSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsScheduleSearch() is false

Compliance:

optional - This method must be implemented if supportsScheduleSearch() is true.

getScheduleSearchSessionForCalendar

ScheduleSearchSession getScheduleSearchSessionForCalendar(Id calendarId)
                                                          throws NotFoundException,
                                                                 OperationFailedException

Gets the OsidSession associated with the schedule search service for the given calendar.

Parameters:

calendarId - the Id of the calendar

Returns:

a ScheduleSearchSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsScheduleSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsScheduleSearch() and supportsVisibleFederation() are true.

getScheduleAdminSession

ScheduleAdminSession getScheduleAdminSession()
                                             throws OperationFailedException

Gets the OsidSession associated with the schedule administration service.

Returns:

a ScheduleAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsScheduleAdmin() is false

Compliance:

optional - This method must be implemented if supportsScheduleAdmin() is true.

getScheduleAdminSessionForCalendar

ScheduleAdminSession getScheduleAdminSessionForCalendar(Id calendarId)
                                                        throws NotFoundException,
                                                               OperationFailedException

Gets the OsidSession associated with the schedule admin service for the given calendar.

Parameters:

calendarId - the Id of the calendar

Returns:

a ScheduleAdminSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsScheduleAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsScheduleAdmin() and supportsVisibleFederation() are true.

getScheduleNotificationSession

ScheduleNotificationSession getScheduleNotificationSession(ScheduleReceiver scheduleReceiver)
                                                           throws OperationFailedException

Gets the notification session for notifications pertaining to schedule changes.

Parameters:

scheduleReceiver - the schedule receiver

Returns:

a ScheduleNotificationSession

Throws:

NullArgumentException - scheduleReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsScheduleNotification() is false

Compliance:

optional - This method must be implemented if supportsScheduleNotification() is true.

getScheduleNotificationSessionForCalendar

ScheduleNotificationSession getScheduleNotificationSessionForCalendar(ScheduleReceiver scheduleReceiver,
                                                                    Id calendarId)
                                                                      throws NotFoundException,
                                                                             OperationFailedException

Gets the OsidSession associated with the schedule notification service for the given calendar.

Parameters:

scheduleReceiver - the schedule receiver

calendarId - the Id of the calendar

Returns:

a ScheduleNotificationSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - scheduleReceiver or calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsScheduleNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsScheduleNotification() and supportsVisibleFederation() are true.

getScheduleCalendarSession

ScheduleCalendarSession getScheduleCalendarSession()
                                                   throws OperationFailedException

Gets the session for retrieving schedule to calendar mappings.

Returns:

a ScheduleCalendarSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsScheduleCalendar() is false

Compliance:

optional - This method must be implemented if supportsScheduleCalendar() is true.

getScheduleCalendarAssignmentSession

ScheduleCalendarAssignmentSession getScheduleCalendarAssignmentSession()
                                                                       throws OperationFailedException

Gets the session for assigning schedule to calendar mappings.

Returns:

a ScheduleCalendarAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsScheduleCalendarAssignment() is false

Compliance:

optional - This method must be implemented if supportsScheduleCalendarAssignment() is true.

getScheduleSmartCalendarSession

ScheduleSmartCalendarSession getScheduleSmartCalendarSession(Id calendarId)
                                                             throws NotFoundException,
                                                                    OperationFailedException

Gets the session associated with the schedule smart calendar for the given calendar.

Parameters:

calendarId - the Id of the calendar

Returns:

a ScheduleSmartCalendarSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsScheduleSmartCalendar() is false

Compliance:

optional - This method must be implemented if supportsScheduleSmartCalendar() is true.

getScheduleSlotLookupSession

ScheduleSlotLookupSession getScheduleSlotLookupSession()
                                                       throws OperationFailedException

Gets the OsidSession associated with the schedule slot lookup service.

Returns:

a ScheduleSlotLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsScheduleSlotLookup() is false

Compliance:

optional - This method must be implemented if supportsScheduleSlotLookup() is true.

getScheduleSlotLookupSessionForCalendar

ScheduleSlotLookupSession getScheduleSlotLookupSessionForCalendar(Id calendarId)
                                                                  throws NotFoundException,
                                                                         OperationFailedException

Gets the OsidSession associated with the schedule slot lookup service for the given calendar.

Parameters:

calendarId - the Id of the calendar

Returns:

a ScheduleSlotLookupSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsScheduleSlotLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsScheduleSlotLookup() and supportsVisibleFederation() are true.

getScheduleSlotQuerySession

ScheduleSlotQuerySession getScheduleSlotQuerySession()
                                                     throws OperationFailedException

Gets the OsidSession associated with the schedule slot query service.

Returns:

a ScheduleSlotQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsScheduleSlotQuery() is false

Compliance:

optional - This method must be implemented if supportsScheduleSlotQuery() is true.

getScheduleSlotQuerySessionForCalendar

ScheduleSlotQuerySession getScheduleSlotQuerySessionForCalendar(Id calendarId)
                                                                throws NotFoundException,
                                                                       OperationFailedException

Gets the OsidSession associated with the schedule slot query service for the given calendar.

Parameters:

calendarId - the Id of the calendar

Returns:

a ScheduleSlotQuerySession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsScheduleSlotQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsScheduleSlotQuery() and supportsVisibleFederation() are true.

getScheduleSlotSearchSession

ScheduleSlotSearchSession getScheduleSlotSearchSession()
                                                       throws OperationFailedException

Gets the OsidSession associated with the schedule slot search service.

Returns:

a ScheduleSlotSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsScheduleSlotSearch() is false

Compliance:

optional - This method must be implemented if supportsScheduleSlotSearch() is true.

getScheduleSlotSearchSessionForCalendar

ScheduleSlotSearchSession getScheduleSlotSearchSessionForCalendar(Id calendarId)
                                                                  throws NotFoundException,
                                                                         OperationFailedException

Gets the OsidSession associated with the schedule slot search service for the given calendar.

Parameters:

calendarId - the Id of the calendar

Returns:

a ScheduleSlotSearchSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsScheduleSlotSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsScheduleSlotSearch() and supportsVisibleFederation() are true.

getScheduleSlotAdminSession

ScheduleSlotAdminSession getScheduleSlotAdminSession()
                                                     throws OperationFailedException

Gets the OsidSession associated with the schedule slot administration service.

Returns:

a ScheduleSlotAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsScheduleSlotAdmin() is false

Compliance:

optional - This method must be implemented if supportsScheduleSlotAdmin() is true.

getScheduleSlotAdminSessionForCalendar

ScheduleSlotAdminSession getScheduleSlotAdminSessionForCalendar(Id calendarId)
                                                                throws NotFoundException,
                                                                       OperationFailedException

Gets the OsidSession associated with the schedule slot admin service for the given calendar.

Parameters:

calendarId - the Id of the calendar

Returns:

a ScheduleSlotAdminSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsScheduleSlotAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsScheduleSlotAdmin() and supportsVisibleFederation() are true.

getScheduleSlotNotificationSession

ScheduleSlotNotificationSession getScheduleSlotNotificationSession(ScheduleSlotReceiver scheduleSlotReceiver)
                                                                   throws OperationFailedException

Gets the notification session for notifications pertaining to schedule slot changes.

Parameters:

scheduleSlotReceiver - the schedule slot receiver

Returns:

a ScheduleSlotNotificationSession

Throws:

NullArgumentException - scheduleSlotReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsScheduleSlotNotification() is false

Compliance:

optional - This method must be implemented if supportsScheduleSlotNotification() is true.

getScheduleSlotNotificationSessionForCalendar

ScheduleSlotNotificationSession getScheduleSlotNotificationSessionForCalendar(ScheduleSlotReceiver scheduleSlotReceiver,
                                                                            Id calendarId)
                                                                              throws NotFoundException,
                                                                                     OperationFailedException

Gets the OsidSession associated with the schedule slot notification service for the given calendar.

Parameters:

scheduleSlotReceiver - the schedule slot receiver

calendarId - the Id of the calendar

Returns:

a ScheduleSlotNotificationSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - scheduleSlotReceiver or calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsScheduleSlotNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsScheduleSlotNotification() and supportsVisibleFederation() are true.

getScheduleSlotCalendarSession

ScheduleSlotCalendarSession getScheduleSlotCalendarSession()
                                                           throws OperationFailedException

Gets the session for retrieving schedule slot to calendar mappings.

Returns:

a ScheduleSlotCalendarSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsScheduleSlotCalendar() is false

Compliance:

optional - This method must be implemented if supportsScheduleSlotCalendar() is true.

getScheduleSlotCalendarAssignmentSession

ScheduleSlotCalendarAssignmentSession getScheduleSlotCalendarAssignmentSession()
                                                                               throws OperationFailedException

Gets the session for assigning schedule slot to calendar mappings.

Returns:

a ScheduleSlotCalendarAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsScheduleSlotCalendarAssignment() is false

Compliance:

optional - This method must be implemented if supportsScheduleSlotCalendarAssignment() is true.

getScheduleSlotSmartCalendarSession

ScheduleSlotSmartCalendarSession getScheduleSlotSmartCalendarSession(Id calendarId)
                                                                     throws NotFoundException,
                                                                            OperationFailedException

Gets the session associated with the schedule slot smart calendar for the given calendar.

Parameters:

calendarId - the Id of the calendar

Returns:

a ScheduleSlotSmartCalendarSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsScheduleSlotSmartCalendar() is false

Compliance:

optional - This method must be implemented if supportsScheduleSlotSmartCalendar() is true.

getCommitmentLookupSession

CommitmentLookupSession getCommitmentLookupSession()
                                                   throws OperationFailedException

Gets the OsidSession associated with the commitment lookup service.

Returns:

a CommitmentLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCommitmentLookup() is false

Compliance:

optional - This method must be implemented if supportsCommitmentLookup() is true.

getCommitmentLookupSessionForCalendar

CommitmentLookupSession getCommitmentLookupSessionForCalendar(Id calendarId)
                                                              throws NotFoundException,
                                                                     OperationFailedException

Gets the OsidSession associated with the commitment lookup service for the given calendar.

Parameters:

calendarId - the Id of the calendar

Returns:

a CommitmentLookupSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCommitmentLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsCommitmentLookup() and supportsVisibleFederation() are true.

getCommitmentQuerySession

CommitmentQuerySession getCommitmentQuerySession()
                                                 throws OperationFailedException

Gets the OsidSession associated with the commitment query service.

Returns:

a CommitmentQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCommitmentQuery() is false

Compliance:

optional - This method must be implemented if supportsCommitmentLookup() is true.

getCommitmentQuerySessionForCalendar

CommitmentQuerySession getCommitmentQuerySessionForCalendar(Id calendarId)
                                                            throws NotFoundException,
                                                                   OperationFailedException

Gets the OsidSession associated with the commitment query service for the given calendar.

Parameters:

calendarId - the Id of the calendar

Returns:

a CommitmentQuerySession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCommitmentQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsCommitmentQuery() and supportsVisibleFederation() are true.

getCommitmentSearchSession

CommitmentSearchSession getCommitmentSearchSession()
                                                   throws OperationFailedException

Gets the OsidSession associated with the commitment search service.

Returns:

a CommitmentSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCommitmentSearch() is false

Compliance:

optional - This method must be implemented if supportsCommitmentSearch() is true.

getCommitmentSearchSessionForCalendar

CommitmentSearchSession getCommitmentSearchSessionForCalendar(Id calendarId)
                                                              throws NotFoundException,
                                                                     OperationFailedException

Gets the OsidSession associated with the commitment search service for the given calendar.

Parameters:

calendarId - the Id of the calendar

Returns:

a CommitmentSearchSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCommitmentSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsCommitmentSearch() and supportsVisibleFederation() are true.

getCommitmentAdminSession

CommitmentAdminSession getCommitmentAdminSession()
                                                 throws OperationFailedException

Gets the OsidSession associated with the commitment administration service.

Returns:

a CommitmentAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCommitmentAdmin() is false

Compliance:

optional - This method must be implemented if supportsCommitmentAdmin() is true.

getCommitmentAdminSessionForCalendar

CommitmentAdminSession getCommitmentAdminSessionForCalendar(Id calendarId)
                                                            throws NotFoundException,
                                                                   OperationFailedException

Gets the OsidSession associated with the commitment admin service for the given calendar.

Parameters:

calendarId - the Id of the calendar

Returns:

a CommitmenttAdminSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCommitmentAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsCommitmentAdmin() and supportsVisibleFederation() are true.

getCommitmentNotificationSession

CommitmentNotificationSession getCommitmentNotificationSession(CommitmentReceiver commitmentReceiver)
                                                               throws OperationFailedException

Gets the notification session for notifications pertaining to commitment changes.

Parameters:

commitmentReceiver - the commitment receiver

Returns:

a CommitmentNotificationSession

Throws:

NullArgumentException - commitmentReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCommitmentNotification() is false

Compliance:

optional - This method must be implemented if supportsCommitmentNotification() is true.

getCommitmentNotificationSessionForCalendar

CommitmentNotificationSession getCommitmentNotificationSessionForCalendar(CommitmentReceiver commitmentReceiver,
                                                                        Id calendarId)
                                                                          throws NotFoundException,
                                                                                 OperationFailedException

Gets the OsidSession associated with the commitment notification service for the given calendar.

Parameters:

commitmentReceiver - the commitment receiver

calendarId - the Id of the calendar

Returns:

a CommitmentNotificationSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - commitmentReceiver or calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCommitmentNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsCommitmentNotification() and supportsVisibleFederation() are true.

getCommitmentCalendarSession

CommitmentCalendarSession getCommitmentCalendarSession()
                                                       throws OperationFailedException

Gets the session for retrieving commitment to calendar mappings.

Returns:

a CommitmentCalendarSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCommitmentCalendar() is false

Compliance:

optional - This method must be implemented if supportsCommitmentCalendar() is true.

getCommitmentCalendarAssignmentSession

CommitmentCalendarAssignmentSession getCommitmentCalendarAssignmentSession()
                                                                           throws OperationFailedException

Gets the session for assigning commitment to calendar mappings.

Returns:

a CommitmentCalendarAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCommitmentCalendarAssignment() is false

Compliance:

optional - This method must be implemented if supportsCommitmentCalendarAssignment() is true.

getCommitmentSmartCalendarSession

CommitmentSmartCalendarSession getCommitmentSmartCalendarSession(Id calendarId)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

Gets the session associated with the commitment smart calendar for the given calendar.

Parameters:

calendarId - the Id of the calendar

Returns:

a CommitmentSmartCalendarSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCommitmentSmartCalendar() is false

Compliance:

optional - This method must be implemented if supportsCommitmentSmartCalendar() is true.

getTimePeriodLookupSession

TimePeriodLookupSession getTimePeriodLookupSession()
                                                   throws OperationFailedException

Gets the OsidSession associated with the time period lookup service.

Returns:

a TimePeriodLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTimePeriodLookup() is false

Compliance:

optional - This method must be implemented if supportsTimePeriodLookup() is true.

getTimePeriodLookupSessionForCalendar

TimePeriodLookupSession getTimePeriodLookupSessionForCalendar(Id calendarId)
                                                              throws NotFoundException,
                                                                     OperationFailedException

Gets the OsidSession associated with the time period lookup service for the given calendar.

Parameters:

calendarId - the Id of the calendar

Returns:

a TimePeriodLookupSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTimePeriodLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsTimePeriodLookup() and supportsVisibleFederation() are true.

getTimePeriodQuerySession

TimePeriodQuerySession getTimePeriodQuerySession()
                                                 throws OperationFailedException

Gets the OsidSession associated with the time period query service.

Returns:

a TimePeriodQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTimePeriodQuery() is false

Compliance:

optional - This method must be implemented if supportsTimePeriodQuery() is true.

getTimePeriodQuerySessionForCalendar

TimePeriodQuerySession getTimePeriodQuerySessionForCalendar(Id calendarId)
                                                            throws NotFoundException,
                                                                   OperationFailedException

Gets the OsidSession associated with the time period query service for the given calendar.

Parameters:

calendarId - the Id of the calendar

Returns:

a TimePeriodQuerySession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTimePeriodQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsTimePeriodQuery() and supportsVisibleFederation() are true.

getTimePeriodSearchSession

TimePeriodSearchSession getTimePeriodSearchSession()
                                                   throws OperationFailedException

Gets the OsidSession associated with the time period search service.

Returns:

a TimePeriodSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTimePeriodSearch() is false

Compliance:

optional - This method must be implemented if supportsTimePeriodSearch() is true.

getTimePeriodSearchSessionForCalendar

TimePeriodSearchSession getTimePeriodSearchSessionForCalendar(Id calendarId)
                                                              throws NotFoundException,
                                                                     OperationFailedException

Gets the OsidSession associated with the time period search service for the given calendar.

Parameters:

calendarId - the Id of the calendar

Returns:

a TimePeriodSearchSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTimePeriodSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsTimePeriodSearch() and supportsVisibleFederation() are true.

getTimePeriodAdminSession

TimePeriodAdminSession getTimePeriodAdminSession()
                                                 throws OperationFailedException

Gets the OsidSession associated with the time period administration service.

Returns:

a TimePeriodAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTimePeriodAdmin() is false

Compliance:

optional - This method must be implemented if supportsTimePeriodAdmin() is true.

getTimePeriodAdminSessionForCalendar

TimePeriodAdminSession getTimePeriodAdminSessionForCalendar(Id calendarId)
                                                            throws NotFoundException,
                                                                   OperationFailedException

Gets the OsidSession associated with the time period admin service for the given calendar.

Parameters:

calendarId - the Id of the calendar

Returns:

a TimePeriodAdminSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTimePeriodAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsTimePeriodAdmin() and supportsVisibleFederation() are true.

getTimePeriodNotificationSession

TimePeriodNotificationSession getTimePeriodNotificationSession(TimePeriodReceiver timePeriodReceiver)
                                                               throws OperationFailedException

Gets the notification session for notifications pertaining to time period changes.

Parameters:

timePeriodReceiver - the time period receiver

Returns:

a TimePeriodNotificationSession

Throws:

NullArgumentException - timePeriodReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTimePeriodNotification() is false

Compliance:

optional - This method must be implemented if supportsTimePeriodNotification() is true.

getTimePeriodNotificationSessionForCalendar

TimePeriodNotificationSession getTimePeriodNotificationSessionForCalendar(TimePeriodReceiver timePeriodReceiver,
                                                                        Id calendarId)
                                                                          throws NotFoundException,
                                                                                 OperationFailedException

Gets the OsidSession associated with the time period notification service for the given calendar.

Parameters:

timePeriodReceiver - the time period receiver

calendarId - the Id of the calendar

Returns:

a TimePeriodNotificationSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - timePeriodReceiver or calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTimePeriodNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsTimePeriodNotification() and supportsVisibleFederation() are true.

getTimePeriodCalendarSession

TimePeriodCalendarSession getTimePeriodCalendarSession()
                                                       throws OperationFailedException

Gets the session for retrieving time period to calendar mappings.

Returns:

a TimePeriodCalendarSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTimePeriodCalendar() is false

Compliance:

optional - This method must be implemented if supportsTimePeriodCalendar() is true.

getTimePeriodCalendarAssignmentSession

TimePeriodCalendarAssignmentSession getTimePeriodCalendarAssignmentSession()
                                                                           throws OperationFailedException

Gets the session for assigning time period to calendar mappings.

Returns:

a TimePeriodCalendarAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTimePeriodCalendarAssignment() is false

Compliance:

optional - This method must be implemented if supportsTimePeriodCalendarAssignment() is true.

getTimePeriodSmartCalendarSession

TimePeriodSmartCalendarSession getTimePeriodSmartCalendarSession(Id calendarId)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

Gets the session associated with the time period smart calendar for the given calendar.

Parameters:

calendarId - the Id of the calendar

Returns:

a TimePeriodSmartCalendarSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTimePeriodSmartCalendar() is false

Compliance:

optional - This method must be implemented if supportsTimePeriodSmartCalendar() is true.

getCalendarLookupSession

CalendarLookupSession getCalendarLookupSession()
                                               throws OperationFailedException

Gets the OsidSession associated with the calendar lookup service.

Returns:

a CalendarLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCalendarLookup() is false

Compliance:

optional - This method must be implemented if supportsCalendarLookup() is true.

getCalendarSearchSession

CalendarSearchSession getCalendarSearchSession()
                                               throws OperationFailedException

Gets the OsidSession associated with the calendar search service.

Returns:

a CalendarSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCalendarSearch() is false

Compliance:

optional - This method must be implemented if supportsCalendarSearch() is true.

getCalendarAdminSession

CalendarAdminSession getCalendarAdminSession()
                                             throws OperationFailedException

Gets the OsidSession associated with the calendar administration service.

Returns:

a CalendarAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCalendarAdmin() is false

Compliance:

optional - This method must be implemented if supportsCalendarAdmin() is true.

getCalendarNotificationSession

CalendarNotificationSession getCalendarNotificationSession(CalendarReceiver calendarReceiver)
                                                           throws OperationFailedException

Gets the notification session for notifications pertaining to calendar service changes.

Parameters:

calendarReceiver - the calendar receiver

Returns:

a CalendarNotificationSession

Throws:

NullArgumentException - calendarReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCalendarNotification() is false

Compliance:

optional - This method must be implemented if supportsCalendarNotification() is true.

getCalendarHierarchySession

CalendarHierarchySession getCalendarHierarchySession()
                                                     throws OperationFailedException

Gets the session traversing calendar hierarchies.

Returns:

a CalendarHierarchySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCalendarHierarchy() is false

Compliance:

optional - This method must be implemented if supportsCalendarHierarchy() is true.

getCalendarHierarchyDesignSession

CalendarHierarchyDesignSession getCalendarHierarchyDesignSession()
                                                                 throws OperationFailedException

Gets the session designing calendar hierarchies.

Returns:

a CalendarHierarchyDesignSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCalendarHierarchyDesign() is false

Compliance:

optional - This method must be implemented if supportsCalendarHierarchyDesign() is true.

getCalandaringBatchManager

CalendaringBatchManager getCalandaringBatchManager()
                                                   throws OperationFailedException

Gets the calendaring batch manager.

Returns:

a CalendaringBatchManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCalendaringBatch() is false

Compliance:

optional - This method must be implemented if supportsCalendaringBatch() is true.

getCalandaringCycleManager

CalendaringCycleManager getCalandaringCycleManager()
                                                   throws OperationFailedException

Gets the calendaring cycle manager.

Returns:

a CalendaringCycleManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCalendaringCycle() is false

Compliance:

optional - This method must be implemented if supportsCalendaringCycle() is true.

getCalandaringRulesManager

CalendaringRulesManager getCalandaringRulesManager()
                                                   throws OperationFailedException

Gets the calendaring rules manager.

Returns:

a CalendaringRulesManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCalendaringRules() is false

Compliance:

optional - This method must be implemented if supportsCalendaringRules() is true.