Interface CalendaringManager
- All Superinterfaces:
AutoCloseable, CalendaringProfile, Closeable, OsidManager, OsidManager, OsidProfile, Sourceable
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: asession 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: asession 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: asession 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: asession 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: asession 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
Modifier and TypeMethodDescriptionGets the OsidSession associated with the calendar administration service.Gets the session designing calendar hierarchies.Gets the session traversing calendar hierarchies.Gets the calendaring batch manager.Gets the calendaring cycle manager.Gets the calendaring rules manager.Gets the OsidSession associated with the calendar lookup service.getCalendarNotificationSession(CalendarReceiver calendarReceiver) Gets the notification session for notifications pertaining to calendar service changes.Gets the OsidSession associated with the calendar search service.Gets theOsidSessionassociated with the commitment administration service.getCommitmentAdminSessionForCalendar(Id calendarId) Gets theOsidSessionassociated with the commitment admin service for the given calendar.Gets the session for assigning commitment to calendar mappings.Gets the session for retrieving commitment to calendar mappings.Gets theOsidSessionassociated with the commitment lookup service.getCommitmentLookupSessionForCalendar(Id calendarId) Gets theOsidSessionassociated with the commitment lookup service for the given calendar.getCommitmentNotificationSession(CommitmentReceiver commitmentReceiver) Gets the notification session for notifications pertaining to commitment changes.getCommitmentNotificationSessionForCalendar(CommitmentReceiver commitmentReceiver, Id calendarId) Gets theOsidSessionassociated with the commitment notification service for the given calendar.Gets theOsidSessionassociated with the commitment query service.getCommitmentQuerySessionForCalendar(Id calendarId) Gets theOsidSessionassociated with the commitment query service for the given calendar.Gets theOsidSessionassociated with the commitment search service.getCommitmentSearchSessionForCalendar(Id calendarId) Gets theOsidSessionassociated with the commitment search service for the given calendar.getCommitmentSmartCalendarSession(Id calendarId) Gets the session associated with the commitment smart calendar for the given calendar.Gets theOsidSessionassociated with the event administration service.getEventAdminSessionForCalendar(Id calendarId) Gets theOsidSessionassociated with the event admin service for the given calendar.Gets the session for assigning event to calendar mappings.Gets the session for retrieving event to calendar mappings.Gets theOsidSessionassociated with the event lookup service.getEventLookupSessionForCalendar(Id calendarId) Gets theOsidSessionassociated with the event lookup service for the given calendar.getEventNotificationSession(EventReceiver eventReceiver) Gets the notification session for notifications pertaining to event changes.getEventNotificationSessionForCalendar(EventReceiver eventReceiver, Id calendarId) Gets theOsidSessionassociated with the event notification service for the given calendar.Gets theOsidSessionassociated with the event query service.getEventQuerySessionForCalendar(Id calendarId) Gets theOsidSessionassociated with the event query service for the given calendar.Gets theOsidSessionassociated with the event search service.getEventSearchSessionForCalendar(Id calendarId) Gets theOsidSessionassociated with the event search service for the given calendar.getEventSmartCalendarSession(Id calendarId) Gets the session associated with the event smart calendar for the given calendar.Gets theOsidSessionassociated with the offset event administration service.getOffsetEventAdminSessionForCalendar(Id calendarId) Gets theOsidSessionassociated with the offset event admin service for the given calendar.Gets the session for assigning offset event to calendar mappings.Gets the session for retrieving offset event to calendar mappings.Gets theOsidSessionassociated with the offset event lookup service.getOffsetEventLookupSessionForCalendar(Id calendarId) Gets theOsidSessionassociated with the offset event lookup service for the given calendar.getOffsetEventNotificationSession(OffsetEventReceiver offsetEventReceiver) Gets the notification session for notifications pertaining to offset event changes.getOffsetEventNotificationSessionForCalendar(OffsetEventReceiver offsetEventReceiver, Id calendarId) Gets theOsidSessionassociated with the offset event notification service for the given calendar.Gets theOsidSessionassociated with the offset event query service.getOffsetEventQuerySessionForCalendar(Id calendarId) Gets theOsidSessionassociated with the offset event query service for the given calendar.Gets theOsidSessionassociated with the offset event search service.getOffsetEventSearchSessionForCalendar(Id calendarId) Gets theOsidSessionassociated with the offset event search service for the given calendar.getOffsetEventSmartCalendarSession(Id calendarId) Gets the session associated with the offset event smart calendar for the given calendar.Gets theOsidSessionassociated with the recurring event administration service.getRecurringEventAdminSessionForCalendar(Id calendarId) Gets theOsidSessionassociated with the recurring event admin service for the given calendar.Gets the session for assigning recurring event to calendar mappings.Gets the session for retrieving recurring event to calendar mappings.Gets theOsidSessionassociated with the recurring event lookup service.getRecurringEventLookupSessionForCalendar(Id calendarId) Gets theOsidSessionassociated with the recurring event lookup service for the given calendar.getRecurringEventNotificationSession(RecurringEventReceiver recurringEventReceiver) Gets the notification session for notifications pertaining to recurring event changes.getRecurringEventNotificationSessionForCalendar(RecurringEventReceiver recurringEventReceiver, Id calendarId) Gets theOsidSessionassociated with the recurring event notification service for the given calendar.Gets theOsidSessionassociated with the recurring event query service.getRecurringEventQuerySessionForCalendar(Id calendarId) Gets theOsidSessionassociated with the recurring event query service for the given calendar.Gets theOsidSessionassociated with the recurring event search service.getRecurringEventSearchSessionForCalendar(Id calendarId) Gets theOsidSessionassociated with the recurring event search service for the given calendar.getRecurringEventSmartCalendarSession(Id calendarId) Gets the session associated with the recurring event smart calendar for the given calendar.Gets theOsidSessionassociated with the schedule administration service.getScheduleAdminSessionForCalendar(Id calendarId) Gets theOsidSessionassociated with the schedule admin service for the given calendar.Gets the session for assigning schedule to calendar mappings.Gets the session for retrieving schedule to calendar mappings.Gets theOsidSessionassociated with the schedule lookup service.getScheduleLookupSessionForCalendar(Id calendarId) Gets theOsidSessionassociated with the schedule lookup service for the given calendar.getScheduleNotificationSession(ScheduleReceiver scheduleReceiver) Gets the notification session for notifications pertaining to schedule changes.getScheduleNotificationSessionForCalendar(ScheduleReceiver scheduleReceiver, Id calendarId) Gets theOsidSessionassociated with the schedule notification service for the given calendar.Gets theOsidSessionassociated with the schedule query service.getScheduleQuerySessionForCalendar(Id calendarId) Gets theOsidSessionassociated with the schedule query service for the given calendar.Gets theOsidSessionassociated with the schedule search service.getScheduleSearchSessionForCalendar(Id calendarId) Gets theOsidSessionassociated with the schedule search service for the given calendar.Gets theOsidSessionassociated with the schedule slot administration service.getScheduleSlotAdminSessionForCalendar(Id calendarId) Gets theOsidSessionassociated with the schedule slot admin service for the given calendar.Gets the session for assigning schedule slot to calendar mappings.Gets the session for retrieving schedule slot to calendar mappings.Gets theOsidSessionassociated with the schedule slot lookup service.getScheduleSlotLookupSessionForCalendar(Id calendarId) Gets theOsidSessionassociated with the schedule slot lookup service for the given calendar.getScheduleSlotNotificationSession(ScheduleSlotReceiver scheduleSlotReceiver) Gets the notification session for notifications pertaining to schedule slot changes.getScheduleSlotNotificationSessionForCalendar(ScheduleSlotReceiver scheduleSlotReceiver, Id calendarId) Gets theOsidSessionassociated with the schedule slot notification service for the given calendar.Gets theOsidSessionassociated with the schedule slot query service.getScheduleSlotQuerySessionForCalendar(Id calendarId) Gets theOsidSessionassociated with the schedule slot query service for the given calendar.Gets theOsidSessionassociated with the schedule slot search service.getScheduleSlotSearchSessionForCalendar(Id calendarId) Gets theOsidSessionassociated with the schedule slot search service for the given calendar.getScheduleSlotSmartCalendarSession(Id calendarId) Gets the session associated with the schedule slot smart calendar for the given calendar.getScheduleSmartCalendarSession(Id calendarId) Gets the session associated with the schedule smart calendar for the given calendar.Gets theOsidSessionassociated with the superseding event administration service.getSupersedingEventAdminSessionForCalendar(Id calendarId) Gets theOsidSessionassociated with the superseding event admin service for the given calendar.Gets the session for assigning superseding event to calendar mappings.Gets the session for retrieving superseding event to calendar mappings.Gets theOsidSessionassociated with the superseding event lookup service.getSupersedingEventLookupSessionForCalendar(Id calendarId) Gets theOsidSessionassociated with the superseding event lookup service for the given calendar.getSupersedingEventNotificationSession(SupersedingEventReceiver supersedingEventReceiver) Gets the notification session for notifications pertaining to superseding event changes.getSupersedingEventNotificationSessionForCalendar(SupersedingEventReceiver supersedingEventReceiver, Id calendarId) Gets theOsidSessionassociated with the superseding event notification service for the given calendar.Gets theOsidSessionassociated with the superseding event query service.getSupersedingEventQuerySessionForCalendar(Id calendarId) Gets theOsidSessionassociated with the superseding event query service for the given calendar.Gets theOsidSessionassociated with the superseding event search service.getSupersedingEventSearchSessionForCalendar(Id calendarId) Gets theOsidSessionassociated with the superseding event search service for the given calendar.getSupersedingEventSmartCalendarSession(Id calendarId) Gets the session associated with the superseding event smart calendar for the given calendar.Gets theOsidSessionassociated with the time period administration service.getTimePeriodAdminSessionForCalendar(Id calendarId) Gets theOsidSessionassociated with the time period admin service for the given calendar.Gets the session for assigning time period to calendar mappings.Gets the session for retrieving time period to calendar mappings.Gets theOsidSessionassociated with the time period lookup service.getTimePeriodLookupSessionForCalendar(Id calendarId) Gets theOsidSessionassociated with the time period lookup service for the given calendar.getTimePeriodNotificationSession(TimePeriodReceiver timePeriodReceiver) Gets the notification session for notifications pertaining to time period changes.getTimePeriodNotificationSessionForCalendar(TimePeriodReceiver timePeriodReceiver, Id calendarId) Gets theOsidSessionassociated with the time period notification service for the given calendar.Gets theOsidSessionassociated with the time period query service.getTimePeriodQuerySessionForCalendar(Id calendarId) Gets theOsidSessionassociated with the time period query service for the given calendar.Gets theOsidSessionassociated with the time period search service.getTimePeriodSearchSessionForCalendar(Id calendarId) Gets theOsidSessionassociated with the time period search service for the given calendar.getTimePeriodSmartCalendarSession(Id calendarId) Gets the session associated with the time period smart calendar for the given calendar.Methods inherited from interface 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, supportsTimePeriodQuery, supportsTimePeriodRecordType, supportsTimePeriodSearch, supportsTimePeriodSearchRecordType, supportsTimePeriodSmartCalendar, supportsVisibleFederationModifier and TypeMethodDescriptionGets the supportedCalendarrecord types.Gets the supported calendar search record types.Gets the supportedCommitmentrecord types.Gets the supported commitment search record types.Gets all the coordinate record types supported.Gets the supportedEventrecord types.Gets the supportedEventsearch record types.Gets the supportedOffsetEventrecord types.Gets the supportedOffsetEventsearch record types.Gets the supportedRecurringEventrecord types.Gets the supportedRecurringEventsearch record types.Gets the supportedSchedulerecord types.Gets the supportedSchedulesearch record types.Gets the supportedScheduleSlotrecord types.Gets the supportedScheduleSlotsearch record types.Gets all the spatial unit record types supported.Gets the supportedSupersedingrecord types.Gets the supportedSupersedingEventsearch record types.Gets the supportedTimePeriodrecord types.Gets the supportedTimePeriodsearch record types.booleanTests if a calendar administrative service is supported.booleanTests if a calendar hierarchy traversal is supported.booleanTests if calendar hierarchy design is supported.booleanTests if a calendaring batch subpackage is supported.booleanTests if a calendaring cycle subpackage is supported.booleanTests if a calendaring rules subpackage is supported.booleanTests if a calendar lookup service is supported.booleanTests if calendar notification is supported.booleansupportsCalendarRecordType(Type calendarRecordType) Tests if the givenCalendarrecord type is supported.booleanTests if a calendar search service is supported.booleansupportsCalendarSearchRecordType(Type calendarSearchRecordType) Tests if the given calendar search record type is supported.booleanTests if a commitment administrative service is supported.booleanTests if a commitment to calendar lookup session is available.booleanTests if a commitment to calendar assignment session is available.booleanTests if an event commitment lookup service is supported.booleanTests if commitment notification is supported.booleanTests if a commitment query service is supported.booleansupportsCommitmentRecordType(Type commitmentRecordType) Tests if the givenCommitmentrecord type is supported.booleanTests if a commitment search service is supported.booleansupportsCommitmentSearchRecordType(Type commitmentSearchRecordType) Tests if the given commitment search record type is supported.booleanTests if commitment smart calendaring is available.booleansupportsCoordinateRecordType(Type coordinateRecordType) Tests if a given coordinate record type is supported.booleanTests if an event administrative service is supported.booleanTests if an event to calendar lookup session is available.booleanTests if an event to calendar assignment session is available.booleanTests if an event lookup service is supported.booleanTests if event notification is supported.booleanTests if an event query service is supported.booleansupportsEventRecordType(Type eventRecordType) Tests if the givenEventrecord type is supported.booleanTests if an event search service is supported.booleansupportsEventSearchRecordType(Type eventSearchRecordType) Tests if the givenEventsearch record type is supported.booleanTests if event smart calendaring is available.booleanTests if an offset event administrative service is supported.booleanTests if an offset event to calendar lookup session is available.booleanTests if an offset event to calendar assignment session is available.booleanTests if an offset event lookup service is supported.booleanTests if offset event notification is supported.booleanTests if an offset event query service is supported.booleansupportsOffsetEventRecordType(Type offsetEventRecordType) Tests if the givenOffsetEventrecord type is supported.booleanTests if an offset event search service is supported.booleansupportsOffsetEventSearchRecordType(Type offsetEventSearchRecordType) Tests if the givenOffsetEventsearch record type is supported.booleanTests if offset event smart calendaring is available.booleanTests if a recurring event administrative service is supported.booleanTests if a recurring event to calendar lookup session is available.booleanTests if a recurring event to calendar assignment session is available.booleanTests if a recurring event lookup service is supported.booleanTests if recurring event notification is supported.booleanTests if a recurring event query service is supported.booleansupportsRecurringEventRecordType(Type recurringEventRecordType) Tests if the givenRecurringEventrecord type is supported.booleanTests if a recurring event search service is supported.booleansupportsRecurringEventSearchRecordType(Type recurringEventSearchRecordType) Tests if the givenRecurringEventsearch record type is supported.booleanTests if recurring event smart calendaring is available.booleanTests if a recurring event unravelling service is supported.booleanTests if a schedule administrative service is supported.booleanTests if a schedule to calendar lookup session is available.booleanTests if a schedule to calendar assignment session is available.booleanTests if a schedule lookup service is supported.booleanTests if schedule notification is supported.booleanTests if a schedule query service is supported.booleansupportsScheduleRecordType(Type scheduleRecordType) Tests if the givenSchedulerecord type is supported.booleanTests if a schedule search service is supported.booleansupportsScheduleSearchRecordType(Type scheduleSearchRecordType) Tests if the givenSchedulesearch record type is supported.booleanTests if a schedule slot administrative service is supported.booleanTests if a schedule slot to calendar lookup session is available.booleanTests if a schedule slot to calendar assignment session is available.booleanTests if a schedule slot lookup service is supported.booleanTests if schedule slot notification is supported.booleanTests if a schedule slot query service is supported.booleansupportsScheduleSlotRecordType(Type scheduleSlotRecordType) Tests if the givenScheduleSlotrecord type is supported.booleanTests if a schedule slot search service is supported.booleansupportsScheduleSlotSearchRecordType(Type scheduleSlotSearchRecordType) Tests if the givenScheduleSlotsearch record type is supported.booleanTests if schedule slot smart calendaring is available.booleanTests if schedule smart calendaring is available.booleansupportsSpatialUnitRecordType(Type spatialUnitRecordType) Tests if a given spatial unit record type is supported.booleanTests if a superseding event administrative service is supported.booleanTests if superseding event to calendar lookup session is available.booleanTests if a superseding event to calendar assignment session is available.booleanTests if a superseding event lookup service is supported.booleanTests if superseding event notification is supported.booleanTests if a superseding event query service is supported.booleansupportsSupersedingEventRecordType(Type supersedingEventRecordType) Tests if the givenSupersedingEventrecord type is supported.booleanTests if a superseding event search service is supported.booleansupportsSupersedingEventSearchRecordType(Type supersedingEventSearchRecordType) Tests if the givenSupersedingEventsearch record type is supported.booleanTests if supsreding event smart calendaring is available.booleanTests if a time period administrative service is supported.booleanTests if a time period to calendar lookup session is available.booleanTests if a time period to calendar assignment session is available.booleanTests if a time period lookup service is supported.booleanTests if time period notification is supported.booleanTests if a time period query service is supported.booleansupportsTimePeriodRecordType(Type timePeriodRecordType) Tests if the givenTimePeriodrecord type is supported.booleanTests if a time period search service is supported.booleansupportsTimePeriodSearchRecordType(Type timePeriodSearchRecordType) Tests if the givenTimePeriodsearch record type is supported.booleanTests if time period smart calendaring is available.booleanTests if federation is visible.Methods inherited from interface OsidManager
closeMethods inherited from interface OsidManager
changeBranch, initialize, rollbackServiceModifier and TypeMethodDescriptionvoidchangeBranch(Id branchId) Changes the service branch.voidinitialize(OsidRuntimeManager runtime) Initializes this manager.rollbackService(Date rollbackTime) Rolls back this service to a point in time.Methods inherited from interface OsidProfile
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordTypeModifier and TypeMethodDescriptionGets this service branch.Gets theBranch Idrepresenting this service branch.Gets a description of this service implementation.Gets a display name for this service implementation.getId()Gets an identifier for this service implementation.Gets the locales supported in this service.Gets the proxy recordTypessupported in this service.Gets the date this service implementation was released.Gets the version of this service implementation.booleanTest for support of a journal branching service.booleanTest for support of a journaling rollback service.booleansupportsOSIDVersion(Version version) Test for support of an OSID specification version.booleansupportsProxyRecordType(Type proxyRecordType) Test for support of a proxy type.Methods inherited from interface Sourceable
getBranding, getBrandingIds, getLicense, getProvider, getProviderIdModifier and TypeMethodDescriptionGets a branding, such as an image or logo, expressed using theAssetinterface.Gets the branding assetIds.Gets the terms of usage.Gets theResourcerepresenting the provider.Gets theIdof the provider.
-
Method Details
-
getEventLookupSession
Gets theOsidSessionassociated with the event lookup service.- Returns:
- an
EventLookupSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsEventLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsEventLookup()} is {@code true} .
-
getEventLookupSessionForCalendar
EventLookupSession getEventLookupSessionForCalendar(Id calendarId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the event lookup service for the given calendar.- Parameters:
calendarId- theIdof the calendar- Returns:
- an
EventLookupSession - Throws:
NotFoundException-calendarIdnot foundNullArgumentException-calendarIdisnullOperationFailedException-unable to complete requestUnimplementedException-supportsEventLookup()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsEventLookup()} and {@code supportsVisibleFederation()} are {@code true} .
-
getEventQuerySession
Gets theOsidSessionassociated with the event query service.- Returns:
- an
EventQuerySession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsEventQuery()isfalse- Compliance:
optional- This method must be implemented if {@code supportsEventQuery()} is {@code true} .
-
getEventQuerySessionForCalendar
EventQuerySession getEventQuerySessionForCalendar(Id calendarId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the event query service for the given calendar.- Parameters:
calendarId- theIdof the calendar- Returns:
- an
EventQuerySession - Throws:
NotFoundException-calendarIdnot foundNullArgumentException-calendarIdisnullOperationFailedException-unable to complete requestUnimplementedException-supportsEventQuery()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsEventQuery()} and {@code supportsVisibleFederation()} are {@code true} .
-
getEventSearchSession
Gets theOsidSessionassociated with the event search service.- Returns:
- an
EventSearchSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsEventSearch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsEventSearch()} is {@code true} .
-
getEventSearchSessionForCalendar
EventSearchSession getEventSearchSessionForCalendar(Id calendarId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the event search service for the given calendar.- Parameters:
calendarId- theIdof the calendar- Returns:
- an
EventSearchSession - Throws:
NotFoundException-calendarIdnot foundNullArgumentException-calendarIdisnullOperationFailedException-unable to complete requestUnimplementedException-supportsEventSearch()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsEventSearch()} and {@code supportsVisibleFederation()} are {@code true} .
-
getEventAdminSession
Gets theOsidSessionassociated with the event administration service.- Returns:
- an
EventAdminSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsEventAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsEventAdmin()} is {@code true} .
-
getEventAdminSessionForCalendar
EventAdminSession getEventAdminSessionForCalendar(Id calendarId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the event admin service for the given calendar.- Parameters:
calendarId- theIdof the calendar- Returns:
- an
EventAdminSession - Throws:
NotFoundException-calendarIdnot foundNullArgumentException-calendarIdisnullOperationFailedException-unable to complete requestUnimplementedException-supportsEventAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsEventAdmin()} and {@code supportsVisibleFederation()} are {@code 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-eventReceiverisnullOperationFailedException- unable to complete requestUnimplementedException-supportsEventNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsEventNotification()} is {@code true} .
-
getEventNotificationSessionForCalendar
EventNotificationSession getEventNotificationSessionForCalendar(EventReceiver eventReceiver, Id calendarId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the event notification service for the given calendar.- Parameters:
eventReceiver- the event receivercalendarId- theIdof the calendar- Returns:
- an
EventNotificationSession - Throws:
NotFoundException-calendarIdnot foundNullArgumentException-eventReceiverorcalendarIdisnullOperationFailedException-unable to complete requestUnimplementedException-supportsEventNotification()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsEventNotification()} and {@code supportsVisibleFederation()} are {@code true} .
-
getEventCalendarSession
Gets the session for retrieving event to calendar mappings.- Returns:
- an
EventCalendarSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsEventCalendar()isfalse- Compliance:
optional- This method must be implemented if {@code supportsEventCalendar()} is {@code true} .
-
getEventCalendarAssignmentSession
Gets the session for assigning event to calendar mappings.- Returns:
- an
EventCalendarAssignmentSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsEventCalendarAssignment()isfalse- Compliance:
optional- This method must be implemented if {@code supportsEventCalendarAssignment()} is {@code true} .
-
getEventSmartCalendarSession
EventSmartCalendarSession getEventSmartCalendarSession(Id calendarId) throws NotFoundException, OperationFailedException Gets the session associated with the event smart calendar for the given calendar.- Parameters:
calendarId- theIdof the calendar- Returns:
- an
EventSmartCalendarSession - Throws:
NotFoundException-calendarIdnot foundNullArgumentException-calendarIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsEventSmartCalendar()isfalse- Compliance:
optional- This method must be implemented if {@code supportsEventSmartCalendar()} is {@code true} .
-
getRecurringEventLookupSession
Gets theOsidSessionassociated with the recurring event lookup service.- Returns:
- a
RecurringEventLookupSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsRecurringEventLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsRecurringEventLookup()} is {@code true} .
-
getRecurringEventLookupSessionForCalendar
RecurringEventLookupSession getRecurringEventLookupSessionForCalendar(Id calendarId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the recurring event lookup service for the given calendar.- Parameters:
calendarId- theIdof the calendar- Returns:
- a
RecurringEventLookupSession - Throws:
NotFoundException-calendarIdnot foundNullArgumentException-calendarIdisnullOperationFailedException-unable to complete requestUnimplementedException-supportsRecurringEventLookup()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsRecurringEventLookup()} and {@code supportsVisibleFederation()} are {@code true} .
-
getRecurringEventQuerySession
Gets theOsidSessionassociated with the recurring event query service.- Returns:
- a
RecurringEventQuerySession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsRecurringEventQuery()isfalse- Compliance:
optional- This method must be implemented if {@code supportsRecurringEventQuery()} is {@code true} .
-
getRecurringEventQuerySessionForCalendar
RecurringEventQuerySession getRecurringEventQuerySessionForCalendar(Id calendarId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the recurring event query service for the given calendar.- Parameters:
calendarId- theIdof the calendar- Returns:
- a
RecurringEventQuerySession - Throws:
NotFoundException-calendarIdnot foundNullArgumentException-calendarIdisnullOperationFailedException-unable to complete requestUnimplementedException-supportsRecurringEventQuery()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsRecurringEventQuery()} and {@code supportsVisibleFederation()} are {@code true} .
-
getRecurringEventSearchSession
Gets theOsidSessionassociated with the recurring event search service.- Returns:
- a
RecurringEventSearchSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsRecurringEventSearch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsRecurringEventSearch()} is {@code true} .
-
getRecurringEventSearchSessionForCalendar
RecurringEventSearchSession getRecurringEventSearchSessionForCalendar(Id calendarId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the recurring event search service for the given calendar.- Parameters:
calendarId- theIdof the calendar- Returns:
- a
RecurringEventSearchSession - Throws:
NotFoundException-calendarIdnot foundNullArgumentException-calendarIdisnullOperationFailedException-unable to complete requestUnimplementedException-supportsRecurringEventSearch()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsRecurringEventSearch()} and {@code supportsVisibleFederation()} are {@code true} .
-
getRecurringEventAdminSession
Gets theOsidSessionassociated with the recurring event administration service.- Returns:
- a
RecurringEventAdminSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsRecurringEventAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsRecurringEventAdmin()} is {@code true} .
-
getRecurringEventAdminSessionForCalendar
RecurringEventAdminSession getRecurringEventAdminSessionForCalendar(Id calendarId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the recurring event admin service for the given calendar.- Parameters:
calendarId- theIdof the calendar- Returns:
- a
RecurringEventAdminSession - Throws:
NotFoundException-calendarIdnot foundNullArgumentException-calendarIdisnullOperationFailedException-unable to complete requestUnimplementedException-supportsRecurringEventAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsRecurringEventAdmin()} and {@code supportsVisibleFederation()} are {@code 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-recurringEventReceiverisnullOperationFailedException- unable to complete requestUnimplementedException-supportsRecurringEventNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsRecurringEventNotification()} is {@code true} .
-
getRecurringEventNotificationSessionForCalendar
RecurringEventNotificationSession getRecurringEventNotificationSessionForCalendar(RecurringEventReceiver recurringEventReceiver, Id calendarId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the recurring event notification service for the given calendar.- Parameters:
recurringEventReceiver- the recurring event receivercalendarId- theIdof the calendar- Returns:
- a
RecurringEventNotificationSession - Throws:
NotFoundException-calendarIdnot foundNullArgumentException-recurringEventReceiverorcalendarIdisnullOperationFailedException-unable to complete requestUnimplementedException-supportsRecurringEventNotification()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsRecurringEventNotification()} and {@code supportsVisibleFederation()} are {@code true} .
-
getRecurringEventCalendarSession
Gets the session for retrieving recurring event to calendar mappings.- Returns:
- A
RecurringEventCalendarSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsRecurringEventCalendar()isfalse- Compliance:
optional- This method must be implemented if {@code supportsRecurringEventCalendar()} is {@code true} .
-
getRecurringEventCalendarAssignmentSession
RecurringEventCalendarAssignmentSession getRecurringEventCalendarAssignmentSession() throws OperationFailedExceptionGets the session for assigning recurring event to calendar mappings.- Returns:
- a
RecurringEventCalendarAssignmentSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsRecurringEventCalendarAssignment()isfalse- Compliance:
optional- This method must be implemented if {@code supportsRecurringEventCalendarAssignment()} is {@code 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- theIdof the calendar- Returns:
- a
RecurringEventSmartCalendarSession - Throws:
NotFoundException-calendarIdnot foundNullArgumentException-calendarIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsRecurringEventSmartCalendar()isfalse- Compliance:
optional- This method must be implemented if {@code supportsRecurringEventSmartCalendar()} is {@code true} .
-
getSupersedingEventLookupSession
Gets theOsidSessionassociated with the superseding event lookup service.- Returns:
- a
SupersedingEventLookupSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsEventLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSupersedingEventLookup()} is {@code true} .
-
getSupersedingEventLookupSessionForCalendar
SupersedingEventLookupSession getSupersedingEventLookupSessionForCalendar(Id calendarId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the superseding event lookup service for the given calendar.- Parameters:
calendarId- theIdof the calendar- Returns:
- a
SupersedingEventLookupSession - Throws:
NotFoundException-calendarIdnot foundNullArgumentException-calendarIdisnullOperationFailedException-unable to complete requestUnimplementedException-supportsSupersedingEventLookup()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSupersedingEventLookup()} and {@code supportsVisibleFederation()} are {@code true} .
-
getSupersedingEventQuerySession
Gets theOsidSessionassociated with the superseding event query service.- Returns:
- a
SupersedingEventQuerySession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsSupersedingEventQuery()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSupersedingEventQuery()} is {@code true} .
-
getSupersedingEventQuerySessionForCalendar
SupersedingEventQuerySession getSupersedingEventQuerySessionForCalendar(Id calendarId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the superseding event query service for the given calendar.- Parameters:
calendarId- theIdof the calendar- Returns:
- a
SupersedingEventQuerySession - Throws:
NotFoundException-calendarIdnot foundNullArgumentException-calendarIdisnullOperationFailedException-unable to complete requestUnimplementedException-supportsSupersedingEventQuery()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSupersedingEventQuery()} and {@code supportsVisibleFederation()} are {@code true} .
-
getSupersedingEventSearchSession
Gets theOsidSessionassociated with the superseding event search service.- Returns:
- a
SupersedingEventSearchSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsEventSearch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsEventSearch()} is {@code true} .
-
getSupersedingEventSearchSessionForCalendar
SupersedingEventSearchSession getSupersedingEventSearchSessionForCalendar(Id calendarId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the superseding event search service for the given calendar.- Parameters:
calendarId- theIdof the calendar- Returns:
- a
SupersedingEventSearchSession - Throws:
NotFoundException-calendarIdnot foundNullArgumentException-calendarIdisnullOperationFailedException-unable to complete requestUnimplementedException-supportsSupersedingEventSearch()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSupersedingEventSearch()} and {@code supportsVisibleFederation()} are {@code true} .
-
getSupersedingEventAdminSession
Gets theOsidSessionassociated with the superseding event administration service.- Returns:
- a
SupersedingEventAdminSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsEventAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSupersedingEventAdmin()} is {@code true} .
-
getSupersedingEventAdminSessionForCalendar
SupersedingEventAdminSession getSupersedingEventAdminSessionForCalendar(Id calendarId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the superseding event admin service for the given calendar.- Parameters:
calendarId- theIdof the calendar- Returns:
- a
SupersedingEventAdminSession - Throws:
NotFoundException-calendarIdnot foundNullArgumentException-calendarIdisnullOperationFailedException-unable to complete requestUnimplementedException-supportsSupersedingEventAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSupersedingEventAdmin()} and {@code supportsVisibleFederation()} are {@code 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-supersedingEventReceiverisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSupersedingEventNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSupersedingEventNotification()} is {@code true} .
-
getSupersedingEventNotificationSessionForCalendar
SupersedingEventNotificationSession getSupersedingEventNotificationSessionForCalendar(SupersedingEventReceiver supersedingEventReceiver, Id calendarId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the superseding event notification service for the given calendar.- Parameters:
supersedingEventReceiver- the superseding event receivercalendarId- theIdof the calendar- Returns:
- a
SupersedingEventNotificationSession - Throws:
NotFoundException-calendarIdnot foundNullArgumentException-supersedingEventReceiverorcalendarIdisnullOperationFailedException-unable to complete requestUnimplementedException-supportsSupersedingEventNotification()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSupersedingEventNotification()} and {@code supportsVisibleFederation()} are {@code true} .
-
getSupersedingEventCalendarSession
SupersedingEventCalendarSession getSupersedingEventCalendarSession() throws OperationFailedExceptionGets the session for retrieving superseding event to calendar mappings.- Returns:
- a
SupersedingEventCalendarSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsSupersedingEventCalendar()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSupersedingEventCalendar()} is {@code true} .
-
getSupersedingEventCalendarAssignmentSession
SupersedingEventCalendarAssignmentSession getSupersedingEventCalendarAssignmentSession() throws OperationFailedExceptionGets the session for assigning superseding event to calendar mappings.- Returns:
- a
SupersedingEventCalendarAssignmentSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsSupersedingEventCalendarAssignment()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSupersedingEventCalendarAssignment()} is {@code 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- theIdof the calendar- Returns:
- a
SupersedingEventSmartCalendarSession - Throws:
NotFoundException-calendarIdnot foundNullArgumentException-calendarIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSupersedingEventSmartCalendar()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSupersedingEventSmartCalendar()} is {@code true} .
-
getOffsetEventLookupSession
Gets theOsidSessionassociated with the offset event lookup service.- Returns:
- an
OffsetEventLookupSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsOffsetEventLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsOffsetEventLookup()} is {@code true} .
-
getOffsetEventLookupSessionForCalendar
OffsetEventLookupSession getOffsetEventLookupSessionForCalendar(Id calendarId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the offset event lookup service for the given calendar.- Parameters:
calendarId- theIdof the calendar- Returns:
- an
OffsetEventLookupSession - Throws:
NotFoundException-calendarIdnot foundNullArgumentException-calendarIdisnullOperationFailedException-unable to complete requestUnimplementedException-supportsOffsetEventLookup()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsOffsetEventLookup()} and {@code supportsVisibleFederation()} are {@code true} .
-
getOffsetEventQuerySession
Gets theOsidSessionassociated with the offset event query service.- Returns:
- an
OffsetEventQuerySession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsOffsetEventQuery()isfalse- Compliance:
optional- This method must be implemented if {@code supportsOffsetEventQuery()} is {@code true} .
-
getOffsetEventQuerySessionForCalendar
OffsetEventQuerySession getOffsetEventQuerySessionForCalendar(Id calendarId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the offset event query service for the given calendar.- Parameters:
calendarId- theIdof the calendar- Returns:
- an
OffsetEventQuerySession - Throws:
NotFoundException-calendarIdnot foundNullArgumentException-calendarIdisnullOperationFailedException-unable to complete requestUnimplementedException-supportsOffsetEventQuery()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsOffsetEventQuery()} and {@code supportsVisibleFederation()} are {@code true} .
-
getOffsetEventSearchSession
Gets theOsidSessionassociated with the offset event search service.- Returns:
- an
OffsetEventSearchSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsOffsetEventSearch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsOffsetEventSearch()} is {@code true} .
-
getOffsetEventSearchSessionForCalendar
OffsetEventSearchSession getOffsetEventSearchSessionForCalendar(Id calendarId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the offset event search service for the given calendar.- Parameters:
calendarId- theIdof the calendar- Returns:
- an
OffsetEventSearchSession - Throws:
NotFoundException-calendarIdnot foundNullArgumentException-calendarIdisnullOperationFailedException-unable to complete requestUnimplementedException-supportsOffsetEventSearch()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsOffsetEventSearch()} and {@code supportsVisibleFederation()} are {@code true} .
-
getOffsetEventAdminSession
Gets theOsidSessionassociated with the offset event administration service.- Returns:
- an
OffsetEventAdminSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsOffsetEventAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsOffsetEventAdmin()} is {@code true} .
-
getOffsetEventAdminSessionForCalendar
OffsetEventAdminSession getOffsetEventAdminSessionForCalendar(Id calendarId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the offset event admin service for the given calendar.- Parameters:
calendarId- theIdof the calendar- Returns:
- an
OffsetEventAdminSession - Throws:
NotFoundException-calendarIdnot foundNullArgumentException-calendarIdisnullOperationFailedException-unable to complete requestUnimplementedException-supportsOffsetEventAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsOffsetEventAdmin()} and {@code supportsVisibleFederation()} are {@code 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-offsetEventReceiverisnullOperationFailedException- unable to complete requestUnimplementedException-supportsOffsetEventNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsOffsetEventNotification()} is {@code true} .
-
getOffsetEventNotificationSessionForCalendar
OffsetEventNotificationSession getOffsetEventNotificationSessionForCalendar(OffsetEventReceiver offsetEventReceiver, Id calendarId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the offset event notification service for the given calendar.- Parameters:
offsetEventReceiver- the offset event receivercalendarId- theIdof the calendar- Returns:
- an
OffsetEventNotificationSession - Throws:
NotFoundException-calendarIdnot foundNullArgumentException-offsetEventReceiverorcalendarIdisnullOperationFailedException-unable to complete requestUnimplementedException-supportsOffsetEventNotification()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsOffsetEventNotification()} and {@code supportsVisibleFederation()} are {@code true} .
-
getOffsetEventCalendarSession
Gets the session for retrieving offset event to calendar mappings.- Returns:
- an
OffsetEventCalendarSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsOffsetEventCalendar()isfalse- Compliance:
optional- This method must be implemented if {@code supportsOffsetEventCalendar()} is {@code true} .
-
getOffsetEventCalendarAssignmentSession
OffsetEventCalendarAssignmentSession getOffsetEventCalendarAssignmentSession() throws OperationFailedExceptionGets the session for assigning offset event to calendar mappings.- Returns:
- an
OffsetEventCalendarAssignmentSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsOffsetEventCalendarAssignment()isfalse- Compliance:
optional- This method must be implemented if {@code supportsOffsetEventCalendarAssignment()} is {@code 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- theIdof the calendar- Returns:
- an
OffsetEventSmartCalendarSession - Throws:
NotFoundException-calendarIdnot foundNullArgumentException-calendarIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsOffsetEventSmartCalendar()isfalse- Compliance:
optional- This method must be implemented if {@code supportsOffsetEventSmartCalendar()} is {@code true} .
-
getScheduleLookupSession
Gets theOsidSessionassociated with the schedule lookup service.- Returns:
- a
ScheduleLookupSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsScheduleLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsScheduleLookup()} is {@code true} .
-
getScheduleLookupSessionForCalendar
ScheduleLookupSession getScheduleLookupSessionForCalendar(Id calendarId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the schedule lookup service for the given calendar.- Parameters:
calendarId- theIdof the calendar- Returns:
- a
ScheduleLookupSession - Throws:
NotFoundException-calendarIdnot foundNullArgumentException-calendarIdisnullOperationFailedException-unable to complete requestUnimplementedException-supportsScheduleLookup()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsScheduleLookup()} and {@code supportsVisibleFederation()} are {@code true} .
-
getScheduleQuerySession
Gets theOsidSessionassociated with the schedule query service.- Returns:
- a
ScheduleQuerySession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsScheduleQuery()isfalse- Compliance:
optional- This method must be implemented if {@code supportsScheduleQuery()} is {@code true} .
-
getScheduleQuerySessionForCalendar
ScheduleQuerySession getScheduleQuerySessionForCalendar(Id calendarId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the schedule query service for the given calendar.- Parameters:
calendarId- theIdof the calendar- Returns:
- a
ScheduleQuerySession - Throws:
NotFoundException-calendarIdnot foundNullArgumentException-calendarIdisnullOperationFailedException-unable to complete requestUnimplementedException-supportsScheduleQuery()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsScheduleQuery()} and {@code supportsVisibleFederation()} are {@code true} .
-
getScheduleSearchSession
Gets theOsidSessionassociated with the schedule search service.- Returns:
- a
ScheduleSearchSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsScheduleSearch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsScheduleSearch()} is {@code true} .
-
getScheduleSearchSessionForCalendar
ScheduleSearchSession getScheduleSearchSessionForCalendar(Id calendarId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the schedule search service for the given calendar.- Parameters:
calendarId- theIdof the calendar- Returns:
- a
ScheduleSearchSession - Throws:
NotFoundException-calendarIdnot foundNullArgumentException-calendarIdisnullOperationFailedException-unable to complete requestUnimplementedException-supportsScheduleSearch()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsScheduleSearch()} and {@code supportsVisibleFederation()} are {@code true} .
-
getScheduleAdminSession
Gets theOsidSessionassociated with the schedule administration service.- Returns:
- a
ScheduleAdminSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsScheduleAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsScheduleAdmin()} is {@code true} .
-
getScheduleAdminSessionForCalendar
ScheduleAdminSession getScheduleAdminSessionForCalendar(Id calendarId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the schedule admin service for the given calendar.- Parameters:
calendarId- theIdof the calendar- Returns:
- a
ScheduleAdminSession - Throws:
NotFoundException-calendarIdnot foundNullArgumentException-calendarIdisnullOperationFailedException-unable to complete requestUnimplementedException-supportsScheduleAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsScheduleAdmin()} and {@code supportsVisibleFederation()} are {@code 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-scheduleReceiverisnullOperationFailedException- unable to complete requestUnimplementedException-supportsScheduleNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsScheduleNotification()} is {@code true} .
-
getScheduleNotificationSessionForCalendar
ScheduleNotificationSession getScheduleNotificationSessionForCalendar(ScheduleReceiver scheduleReceiver, Id calendarId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the schedule notification service for the given calendar.- Parameters:
scheduleReceiver- the schedule receivercalendarId- theIdof the calendar- Returns:
- a
ScheduleNotificationSession - Throws:
NotFoundException-calendarIdnot foundNullArgumentException-scheduleReceiverorcalendarIdisnullOperationFailedException-unable to complete requestUnimplementedException-supportsScheduleNotification()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsScheduleNotification()} and {@code supportsVisibleFederation()} are {@code true} .
-
getScheduleCalendarSession
Gets the session for retrieving schedule to calendar mappings.- Returns:
- a
ScheduleCalendarSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsScheduleCalendar()isfalse- Compliance:
optional- This method must be implemented if {@code supportsScheduleCalendar()} is {@code true} .
-
getScheduleCalendarAssignmentSession
ScheduleCalendarAssignmentSession getScheduleCalendarAssignmentSession() throws OperationFailedExceptionGets the session for assigning schedule to calendar mappings.- Returns:
- a
ScheduleCalendarAssignmentSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsScheduleCalendarAssignment()isfalse- Compliance:
optional- This method must be implemented if {@code supportsScheduleCalendarAssignment()} is {@code true} .
-
getScheduleSmartCalendarSession
ScheduleSmartCalendarSession getScheduleSmartCalendarSession(Id calendarId) throws NotFoundException, OperationFailedException Gets the session associated with the schedule smart calendar for the given calendar.- Parameters:
calendarId- theIdof the calendar- Returns:
- a
ScheduleSmartCalendarSession - Throws:
NotFoundException-calendarIdnot foundNullArgumentException-calendarIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsScheduleSmartCalendar()isfalse- Compliance:
optional- This method must be implemented if {@code supportsScheduleSmartCalendar()} is {@code true} .
-
getScheduleSlotLookupSession
Gets theOsidSessionassociated with the schedule slot lookup service.- Returns:
- a
ScheduleSlotLookupSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsScheduleSlotLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsScheduleSlotLookup()} is {@code true} .
-
getScheduleSlotLookupSessionForCalendar
ScheduleSlotLookupSession getScheduleSlotLookupSessionForCalendar(Id calendarId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the schedule slot lookup service for the given calendar.- Parameters:
calendarId- theIdof the calendar- Returns:
- a
ScheduleSlotLookupSession - Throws:
NotFoundException-calendarIdnot foundNullArgumentException-calendarIdisnullOperationFailedException-unable to complete requestUnimplementedException-supportsScheduleSlotLookup()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsScheduleSlotLookup()} and {@code supportsVisibleFederation()} are {@code true} .
-
getScheduleSlotQuerySession
Gets theOsidSessionassociated with the schedule slot query service.- Returns:
- a
ScheduleSlotQuerySession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsScheduleSlotQuery()isfalse- Compliance:
optional- This method must be implemented if {@code supportsScheduleSlotQuery()} is {@code true} .
-
getScheduleSlotQuerySessionForCalendar
ScheduleSlotQuerySession getScheduleSlotQuerySessionForCalendar(Id calendarId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the schedule slot query service for the given calendar.- Parameters:
calendarId- theIdof the calendar- Returns:
- a
ScheduleSlotQuerySession - Throws:
NotFoundException-calendarIdnot foundNullArgumentException-calendarIdisnullOperationFailedException-unable to complete requestUnimplementedException-supportsScheduleSlotQuery()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsScheduleSlotQuery()} and {@code supportsVisibleFederation()} are {@code true} .
-
getScheduleSlotSearchSession
Gets theOsidSessionassociated with the schedule slot search service.- Returns:
- a
ScheduleSlotSearchSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsScheduleSlotSearch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsScheduleSlotSearch()} is {@code true} .
-
getScheduleSlotSearchSessionForCalendar
ScheduleSlotSearchSession getScheduleSlotSearchSessionForCalendar(Id calendarId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the schedule slot search service for the given calendar.- Parameters:
calendarId- theIdof the calendar- Returns:
- a
ScheduleSlotSearchSession - Throws:
NotFoundException-calendarIdnot foundNullArgumentException-calendarIdisnullOperationFailedException-unable to complete requestUnimplementedException-supportsScheduleSlotSearch()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsScheduleSlotSearch()} and {@code supportsVisibleFederation()} are {@code true} .
-
getScheduleSlotAdminSession
Gets theOsidSessionassociated with the schedule slot administration service.- Returns:
- a
ScheduleSlotAdminSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsScheduleSlotAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsScheduleSlotAdmin()} is {@code true} .
-
getScheduleSlotAdminSessionForCalendar
ScheduleSlotAdminSession getScheduleSlotAdminSessionForCalendar(Id calendarId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the schedule slot admin service for the given calendar.- Parameters:
calendarId- theIdof the calendar- Returns:
- a
ScheduleSlotAdminSession - Throws:
NotFoundException-calendarIdnot foundNullArgumentException-calendarIdisnullOperationFailedException-unable to complete requestUnimplementedException-supportsScheduleSlotAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsScheduleSlotAdmin()} and {@code supportsVisibleFederation()} are {@code 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-scheduleSlotReceiverisnullOperationFailedException- unable to complete requestUnimplementedException-supportsScheduleSlotNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsScheduleSlotNotification()} is {@code true} .
-
getScheduleSlotNotificationSessionForCalendar
ScheduleSlotNotificationSession getScheduleSlotNotificationSessionForCalendar(ScheduleSlotReceiver scheduleSlotReceiver, Id calendarId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the schedule slot notification service for the given calendar.- Parameters:
scheduleSlotReceiver- the schedule slot receivercalendarId- theIdof the calendar- Returns:
- a
ScheduleSlotNotificationSession - Throws:
NotFoundException-calendarIdnot foundNullArgumentException-scheduleSlotReceiverorcalendarIdisnullOperationFailedException-unable to complete requestUnimplementedException-supportsScheduleSlotNotification()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsScheduleSlotNotification()} and {@code supportsVisibleFederation()} are {@code true} .
-
getScheduleSlotCalendarSession
Gets the session for retrieving schedule slot to calendar mappings.- Returns:
- a
ScheduleSlotCalendarSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsScheduleSlotCalendar()isfalse- Compliance:
optional- This method must be implemented if {@code supportsScheduleSlotCalendar()} is {@code true} .
-
getScheduleSlotCalendarAssignmentSession
ScheduleSlotCalendarAssignmentSession getScheduleSlotCalendarAssignmentSession() throws OperationFailedExceptionGets the session for assigning schedule slot to calendar mappings.- Returns:
- a
ScheduleSlotCalendarAssignmentSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsScheduleSlotCalendarAssignment()isfalse- Compliance:
optional- This method must be implemented if {@code supportsScheduleSlotCalendarAssignment()} is {@code 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- theIdof the calendar- Returns:
- a
ScheduleSlotSmartCalendarSession - Throws:
NotFoundException-calendarIdnot foundNullArgumentException-calendarIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsScheduleSlotSmartCalendar()isfalse- Compliance:
optional- This method must be implemented if {@code supportsScheduleSlotSmartCalendar()} is {@code true} .
-
getCommitmentLookupSession
Gets theOsidSessionassociated with the commitment lookup service.- Returns:
- a
CommitmentLookupSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsCommitmentLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCommitmentLookup()} is {@code true} .
-
getCommitmentLookupSessionForCalendar
CommitmentLookupSession getCommitmentLookupSessionForCalendar(Id calendarId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the commitment lookup service for the given calendar.- Parameters:
calendarId- theIdof the calendar- Returns:
- a
CommitmentLookupSession - Throws:
NotFoundException-calendarIdnot foundNullArgumentException-calendarIdisnullOperationFailedException-unable to complete requestUnimplementedException-supportsCommitmentLookup()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCommitmentLookup()} and {@code supportsVisibleFederation()} are {@code true} .
-
getCommitmentQuerySession
Gets theOsidSessionassociated with the commitment query service.- Returns:
- a
CommitmentQuerySession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsCommitmentQuery()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCommitmentLookup()} is {@code true} .
-
getCommitmentQuerySessionForCalendar
CommitmentQuerySession getCommitmentQuerySessionForCalendar(Id calendarId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the commitment query service for the given calendar.- Parameters:
calendarId- theIdof the calendar- Returns:
- a
CommitmentQuerySession - Throws:
NotFoundException-calendarIdnot foundNullArgumentException-calendarIdisnullOperationFailedException-unable to complete requestUnimplementedException-supportsCommitmentQuery()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCommitmentQuery()} and {@code supportsVisibleFederation()} are {@code true} .
-
getCommitmentSearchSession
Gets theOsidSessionassociated with the commitment search service.- Returns:
- a
CommitmentSearchSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsCommitmentSearch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCommitmentSearch()} is {@code true} .
-
getCommitmentSearchSessionForCalendar
CommitmentSearchSession getCommitmentSearchSessionForCalendar(Id calendarId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the commitment search service for the given calendar.- Parameters:
calendarId- theIdof the calendar- Returns:
- a
CommitmentSearchSession - Throws:
NotFoundException-calendarIdnot foundNullArgumentException-calendarIdisnullOperationFailedException-unable to complete requestUnimplementedException-supportsCommitmentSearch()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCommitmentSearch()} and {@code supportsVisibleFederation()} are {@code true} .
-
getCommitmentAdminSession
Gets theOsidSessionassociated with the commitment administration service.- Returns:
- a
CommitmentAdminSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsCommitmentAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCommitmentAdmin()} is {@code true} .
-
getCommitmentAdminSessionForCalendar
CommitmentAdminSession getCommitmentAdminSessionForCalendar(Id calendarId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the commitment admin service for the given calendar.- Parameters:
calendarId- theIdof the calendar- Returns:
- a
CommitmenttAdminSession - Throws:
NotFoundException-calendarIdnot foundNullArgumentException-calendarIdisnullOperationFailedException-unable to complete requestUnimplementedException-supportsCommitmentAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCommitmentAdmin()} and {@code supportsVisibleFederation()} are {@code 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-commitmentReceiverisnullOperationFailedException- unable to complete requestUnimplementedException-supportsCommitmentNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCommitmentNotification()} is {@code true} .
-
getCommitmentNotificationSessionForCalendar
CommitmentNotificationSession getCommitmentNotificationSessionForCalendar(CommitmentReceiver commitmentReceiver, Id calendarId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the commitment notification service for the given calendar.- Parameters:
commitmentReceiver- the commitment receivercalendarId- theIdof the calendar- Returns:
- a
CommitmentNotificationSession - Throws:
NotFoundException-calendarIdnot foundNullArgumentException-commitmentReceiverorcalendarIdisnullOperationFailedException-unable to complete requestUnimplementedException-supportsCommitmentNotification()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCommitmentNotification()} and {@code supportsVisibleFederation()} are {@code true} .
-
getCommitmentCalendarSession
Gets the session for retrieving commitment to calendar mappings.- Returns:
- a
CommitmentCalendarSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsCommitmentCalendar()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCommitmentCalendar()} is {@code true} .
-
getCommitmentCalendarAssignmentSession
CommitmentCalendarAssignmentSession getCommitmentCalendarAssignmentSession() throws OperationFailedExceptionGets the session for assigning commitment to calendar mappings.- Returns:
- a
CommitmentCalendarAssignmentSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsCommitmentCalendarAssignment()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCommitmentCalendarAssignment()} is {@code true} .
-
getCommitmentSmartCalendarSession
CommitmentSmartCalendarSession getCommitmentSmartCalendarSession(Id calendarId) throws NotFoundException, OperationFailedException Gets the session associated with the commitment smart calendar for the given calendar.- Parameters:
calendarId- theIdof the calendar- Returns:
- a
CommitmentSmartCalendarSession - Throws:
NotFoundException-calendarIdnot foundNullArgumentException-calendarIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsCommitmentSmartCalendar()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCommitmentSmartCalendar()} is {@code true} .
-
getTimePeriodLookupSession
Gets theOsidSessionassociated with the time period lookup service.- Returns:
- a
TimePeriodLookupSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsTimePeriodLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsTimePeriodLookup()} is {@code true} .
-
getTimePeriodLookupSessionForCalendar
TimePeriodLookupSession getTimePeriodLookupSessionForCalendar(Id calendarId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the time period lookup service for the given calendar.- Parameters:
calendarId- theIdof the calendar- Returns:
- a
TimePeriodLookupSession - Throws:
NotFoundException-calendarIdnot foundNullArgumentException-calendarIdisnullOperationFailedException-unable to complete requestUnimplementedException-supportsTimePeriodLookup()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsTimePeriodLookup()} and {@code supportsVisibleFederation()} are {@code true} .
-
getTimePeriodQuerySession
Gets theOsidSessionassociated with the time period query service.- Returns:
- a
TimePeriodQuerySession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsTimePeriodQuery()isfalse- Compliance:
optional- This method must be implemented if {@code supportsTimePeriodQuery()} is {@code true} .
-
getTimePeriodQuerySessionForCalendar
TimePeriodQuerySession getTimePeriodQuerySessionForCalendar(Id calendarId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the time period query service for the given calendar.- Parameters:
calendarId- theIdof the calendar- Returns:
- a
TimePeriodQuerySession - Throws:
NotFoundException-calendarIdnot foundNullArgumentException-calendarIdisnullOperationFailedException-unable to complete requestUnimplementedException-supportsTimePeriodQuery()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsTimePeriodQuery()} and {@code supportsVisibleFederation()} are {@code true} .
-
getTimePeriodSearchSession
Gets theOsidSessionassociated with the time period search service.- Returns:
- a
TimePeriodSearchSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsTimePeriodSearch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsTimePeriodSearch()} is {@code true} .
-
getTimePeriodSearchSessionForCalendar
TimePeriodSearchSession getTimePeriodSearchSessionForCalendar(Id calendarId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the time period search service for the given calendar.- Parameters:
calendarId- theIdof the calendar- Returns:
- a
TimePeriodSearchSession - Throws:
NotFoundException-calendarIdnot foundNullArgumentException-calendarIdisnullOperationFailedException-unable to complete requestUnimplementedException-supportsTimePeriodSearch()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsTimePeriodSearch()} and {@code supportsVisibleFederation()} are {@code true} .
-
getTimePeriodAdminSession
Gets theOsidSessionassociated with the time period administration service.- Returns:
- a
TimePeriodAdminSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsTimePeriodAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsTimePeriodAdmin()} is {@code true} .
-
getTimePeriodAdminSessionForCalendar
TimePeriodAdminSession getTimePeriodAdminSessionForCalendar(Id calendarId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the time period admin service for the given calendar.- Parameters:
calendarId- theIdof the calendar- Returns:
- a
TimePeriodAdminSession - Throws:
NotFoundException-calendarIdnot foundNullArgumentException-calendarIdisnullOperationFailedException-unable to complete requestUnimplementedException-supportsTimePeriodAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsTimePeriodAdmin()} and {@code supportsVisibleFederation()} are {@code 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-timePeriodReceiverisnullOperationFailedException- unable to complete requestUnimplementedException-supportsTimePeriodNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsTimePeriodNotification()} is {@code true} .
-
getTimePeriodNotificationSessionForCalendar
TimePeriodNotificationSession getTimePeriodNotificationSessionForCalendar(TimePeriodReceiver timePeriodReceiver, Id calendarId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the time period notification service for the given calendar.- Parameters:
timePeriodReceiver- the time period receivercalendarId- theIdof the calendar- Returns:
- a
TimePeriodNotificationSession - Throws:
NotFoundException-calendarIdnot foundNullArgumentException-timePeriodReceiverorcalendarIdisnullOperationFailedException-unable to complete requestUnimplementedException-supportsTimePeriodNotification()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsTimePeriodNotification()} and {@code supportsVisibleFederation()} are {@code true} .
-
getTimePeriodCalendarSession
Gets the session for retrieving time period to calendar mappings.- Returns:
- a
TimePeriodCalendarSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsTimePeriodCalendar()isfalse- Compliance:
optional- This method must be implemented if {@code supportsTimePeriodCalendar()} is {@code true} .
-
getTimePeriodCalendarAssignmentSession
TimePeriodCalendarAssignmentSession getTimePeriodCalendarAssignmentSession() throws OperationFailedExceptionGets the session for assigning time period to calendar mappings.- Returns:
- a
TimePeriodCalendarAssignmentSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsTimePeriodCalendarAssignment()isfalse- Compliance:
optional- This method must be implemented if {@code supportsTimePeriodCalendarAssignment()} is {@code 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- theIdof the calendar- Returns:
- a
TimePeriodSmartCalendarSession - Throws:
NotFoundException-calendarIdnot foundNullArgumentException-calendarIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsTimePeriodSmartCalendar()isfalse- Compliance:
optional- This method must be implemented if {@code supportsTimePeriodSmartCalendar()} is {@code true} .
-
getCalendarLookupSession
Gets the OsidSession associated with the calendar lookup service.- Returns:
- a
CalendarLookupSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsCalendarLookup() is false- Compliance:
optional- This method must be implemented if {@code supportsCalendarLookup()} is true.
-
getCalendarSearchSession
Gets the OsidSession associated with the calendar search service.- Returns:
- a
CalendarSearchSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsCalendarSearch() is false- Compliance:
optional- This method must be implemented if {@code supportsCalendarSearch()} is true.
-
getCalendarAdminSession
Gets the OsidSession associated with the calendar administration service.- Returns:
- a
CalendarAdminSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsCalendarAdmin() is false- Compliance:
optional- This method must be implemented if {@code 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-calendarReceiverisnullOperationFailedException- unable to complete requestUnimplementedException-supportsCalendarNotification() is false- Compliance:
optional- This method must be implemented if {@code supportsCalendarNotification()} is true.
-
getCalendarHierarchySession
Gets the session traversing calendar hierarchies.- Returns:
- a
CalendarHierarchySession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsCalendarHierarchy() is false- Compliance:
optional- This method must be implemented if {@code supportsCalendarHierarchy()} is true.
-
getCalendarHierarchyDesignSession
Gets the session designing calendar hierarchies.- Returns:
- a
CalendarHierarchyDesignSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsCalendarHierarchyDesign() is false- Compliance:
optional- This method must be implemented if {@code supportsCalendarHierarchyDesign()} is true.
-
getCalendaringBatchManager
Gets the calendaring batch manager.- Returns:
- a
CalendaringBatchManager - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsCalendaringBatch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCalendaringBatch()} is {@code true} .
-
getCalendaringCycleManager
Gets the calendaring cycle manager.- Returns:
- a
CalendaringCycleManager - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsCalendaringCycle()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCalendaringCycle()} is {@code true} .
-
getCalendaringRulesManager
Gets the calendaring rules manager.- Returns:
- a
CalendaringRulesManager - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsCalendaringRules()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCalendaringRules()} is {@code true} .
-