org.osid.calendaring.cycle

Interface CalendaringCycleProxyManager

All Superinterfaces:

java.lang.AutoCloseable, CalendaringCycleProfile, java.io.Closeable, OsidProfile, OsidProxyManager, Sourceable

public interface CalendaringCycleProxyManager
extends OsidProxyManager, CalendaringCycleProfile

The calendaring manager provides access to calendaring sessions and provides interoperability tests for various aspects of this service. Methods in this manager support the passing of a Proxy object. The sessions included in this manager are:

• CyclicEventLookupSession: a session to look up cyclic events
• CyclicEventQuerySession: a session to query cyclic events
• CyclicEventSearchSession: a session to search cyclic events
• CyclicEventAdminSession: a session to create, modify and delete cyclic events
• CyclicEventNotificationSession: a session to receive messages pertaining to cyclic event changes
• CyclicEventCalendarSession: a session for retriieving cyclic event and calendar mappings
• CyclicEventCalendarAssignmentSession: a session for managing cyclic event and calendar mappings
• CyclicEventSmartCalendarSession: a session to manage dynamic cyclic event catalogs

• CyclicTimePeriodLookupSession: a session to look up cyclic time periods
• CyclicTimePeriodQuerySession: a session to query cyclic time periods
• CyclicTimePeriodSearchSession: a session to search cyclic time periods
• CyclicTimePeriodAdminSession: a session to create, modify and delete cyclic time periods
• CyclicTimePeriodNotificationSession: a session to receive messages pertaining to cyclic time period changes
• CyclicTimePeriodCalendarSession: a session for retriieving cyclic time period and calendar mappings
• CyclicTimePeriodCalendarAssignmentSession: a session for managing cyclic time period and calendar mappings
• CyclicTimePeriodSmartCalendarSession: a session to manage dynamic cyclic time period catalogs

Method Summary

Methods

Modifier and Type	Method and Description
CalendaringCycleBatchProxyManager	getCalendaringCycleBatchProxyManager() Gets a CalendaringCycleBatchProxyManager.
CyclicEventAdminSession	getCyclicEventAdminSession(Proxy proxy) Gets the OsidSession associated with the cyclic event administration service.
CyclicEventAdminSession	getCyclicEventAdminSessionForCalendar(Id calendarId, Proxy proxy) Gets the OsidSession associated with the cyclic event admin service for the given calendar.
CyclicEventCalendarAssignmentSession	getCyclicEventCalendarAssignmentSession(Proxy proxy) Gets the session for assigning event to calendar mappings.
CyclicEventCalendarSession	getCyclicEventCalendarSession(Proxy proxy) Gets the session for retrieving event to calendar mappings.
CyclicEventLookupSession	getCyclicEventLookupSession(Proxy proxy) Gets the OsidSession associated with the cyclic event lookup service.
CyclicEventLookupSession	getCyclicEventLookupSessionForCalendar(Id calendarId, Proxy proxy) Gets the OsidSession associated with the cyclic event lookup service for the given calendar.
CyclicEventNotificationSession	getCyclicEventNotificationSession(CyclicEventReceiver eventReceiver, Proxy proxy) Gets the notification session for notifications pertaining to event changes.
CyclicEventNotificationSession	getCyclicEventNotificationSessionForCalendar(CyclicEventReceiver eventReceiver, Id calendarId, Proxy proxy) Gets the OsidSession associated with the cyclic event notification service for the given calendar.
CyclicEventQuerySession	getCyclicEventQuerySession(Proxy proxy) Gets the OsidSession associated with the cyclic event query service.
CyclicEventQuerySession	getCyclicEventQuerySessionForCalendar(Id calendarId, Proxy proxy) Gets the OsidSession associated with the cyclic event query service for the given calendar.
CyclicEventSearchSession	getCyclicEventSearchSession(Proxy proxy) Gets the OsidSession associated with the cyclic event search service.
CyclicEventSearchSession	getCyclicEventSearchSessionForCalendar(Id calendarId, Proxy proxy) Gets the OsidSession associated with the cyclic event search service for the given calendar.
CyclicEventSmartCalendarSession	getCyclicEventSmartCalendarSession(Id calendarId, Proxy proxy) Gets the session associated with the cyclic event smart calendar for the given calendar.
CyclicTimePeriodAdminSession	getCyclicTimePeriodAdminSession(Proxy proxy) Gets the OsidSession associated with the cyclic time period administration service.
CyclicTimePeriodAdminSession	getCyclicTimePeriodAdminSessionForCalendar(Id calendarId, Proxy proxy) Gets the OsidSession associated with the cyclic time period admin service for the given calendar.
CyclicTimePeriodCalendarAssignmentSession	getCyclicTimePeriodCalendarAssignmentSession(Proxy proxy) Gets the session for assigning cyclic time period to calendar mappings.
CyclicTimePeriodCalendarSession	getCyclicTimePeriodCalendarSession(Proxy proxy) Gets the session for retrieving cyclic time period to calendar mappings.
CyclicTimePeriodLookupSession	getCyclicTimePeriodLookupSession(Proxy proxy) Gets the OsidSession associated with the cyclic time period lookup service.
CyclicTimePeriodLookupSession	getCyclicTimePeriodLookupSessionForCalendar(Id calendarId, Proxy proxy) Gets the OsidSession associated with the cyclic time period lookup service for the given calendar.
CyclicTimePeriodNotificationSession	getCyclicTimePeriodNotificationSession(CyclicTimePeriodReceiver cyclicTimePeriodReceiver, Proxy proxy) Gets the notification session for notifications pertaining to cyclic time period changes.
CyclicTimePeriodNotificationSession	getCyclicTimePeriodNotificationSessionForCalendar(CyclicTimePeriodReceiver cyclicTimePeriodReceiver, Id calendarId, Proxy proxy) Gets the OsidSession associated with the cyclic time period notification service for the given calendar.
CyclicTimePeriodQuerySession	getCyclicTimePeriodQuerySession(Proxy proxy) Gets the OsidSession associated with the cyclic time period query service.
CyclicTimePeriodQuerySession	getCyclicTimePeriodQuerySessionForCalendar(Id calendarId, Proxy proxy) Gets the OsidSession associated with the cyclic time period query service for the given calendar.
CyclicTimePeriodSearchSession	getCyclicTimePeriodSearchSession(Proxy proxy) Gets the OsidSession associated with the cyclic time period search service.
CyclicTimePeriodSearchSession	getCyclicTimePeriodSearchSessionForCalendar(Id calendarId, Proxy proxy) Gets the OsidSession associated with the cyclic time period search service for the given calendar.
CyclicTimePeriodSmartCalendarSession	getCyclicTimePeriodSmartCalendarSession(Id calendarId, Proxy proxy) Gets the session associated with the cyclic time period smart calendar for the given calendar.
EventCyclicEventAssignmentSession	getEventCyclicEventAssignmentSession(Proxy proxy) Gets the session for manually making event to cyclic event associations.
EventCyclicEventAssignmentSession	getEventCyclicEventAssignmentSessionForCalendar(Id calendarId, Proxy proxy) Gets the OsidSession associated with the event cyclic event assignment service for the given calendar.
EventCyclicEventLookupSession	getEventCyclicEventLookupSession(Proxy proxy) Gets the session for retrieving event to cyclic event associations.
EventCyclicEventLookupSession	getEventCyclicEventLookupSessionForCalendar(Id calendarId, Proxy proxy) Gets the OsidSession associated with the event cyclic event lookup service for the given calendar.
TimePeriodCyclicTimePeriodAssignmentSession	getTimePeriodCyclicTimePeriodAssignmentSession(Proxy proxy) Gets the session for manually making time period to cyclic time period associations.
TimePeriodCyclicTimePeriodAssignmentSession	getTimePeriodCyclicTimePeriodAssignmentSessionForCalendar(Id calendarId, Proxy proxy) Gets the OsidSession associated with the time period cyclic time period assignment service for the given calendar.
TimePeriodCyclicTimePeriodLookupSession	getTimePeriodCyclicTimePeriodLookupSession(Proxy proxy) Gets the session for retrieving time period to cyclic time period associations.
TimePeriodCyclicTimePeriodLookupSession	getTimePeriodCyclicTimePeriodLookupSessionForCalendar(Id calendarId, Proxy proxy) Gets the OsidSession associated with the time period cyclic time period lookup service for the given calendar.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

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

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.calendaring.cycle.CalendaringCycleProfile

getCyclicEventRecordTypes, getCyclicEventSearchRecordTypes, getCyclicTimePeriodRecordTypes, getCyclicTimePeriodSearchRecordTypes, supportsCalendaringCycleBatch, supportsCyclicEventAdmin, supportsCyclicEventCalendar, supportsCyclicEventCalendarAssignment, supportsCyclicEventLookup, supportsCyclicEventNotification, supportsCyclicEventQuery, supportsCyclicEventRecordType, supportsCyclicEventSearch, supportsCyclicEventSearchRecordType, supportsCyclicEventSmartCalendar, supportsCyclicTimePeriodAdmin, supportsCyclicTimePeriodCalendar, supportsCyclicTimePeriodCalendarAssignment, supportsCyclicTimePeriodLookup, supportsCyclicTimePeriodNotification, supportsCyclicTimePeriodRecordType, supportsCyclicTimePeriodSearch, supportsCyclicTimePeriodSearchRecordType, supportsCyclicTimePeriodSmartCalendar, supportsEventCyclicEventAssignment, supportsEventCyclicEventLookup, supportsTimePeriodCyclicTimePeriodAssignment, supportsTimePeriodCyclicTimePeriodLookup, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

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

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getCyclicEventLookupSession

CyclicEventLookupSession getCyclicEventLookupSession(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the cyclic event lookup service.

Parameters:

proxy - a proxy

Returns:

an EventLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEventLookup() is false

Compliance:

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

getCyclicEventLookupSessionForCalendar

CyclicEventLookupSession getCyclicEventLookupSessionForCalendar(Id calendarId,
                                                              Proxy proxy)
                                                                throws NotFoundException,
                                                                       OperationFailedException

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

Parameters:

calendarId - the Id of the calendar

proxy - a proxy

Returns:

CyclicEventLookupSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEventLookup() or supportsVisibleFederation() is false

Compliance:

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

getCyclicEventQuerySession

CyclicEventQuerySession getCyclicEventQuerySession(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the cyclic event query service.

Parameters:

proxy - a proxy

Returns:

an EventQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEventQuery() is false

Compliance:

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

getCyclicEventQuerySessionForCalendar

CyclicEventQuerySession getCyclicEventQuerySessionForCalendar(Id calendarId,
                                                            Proxy proxy)
                                                              throws NotFoundException,
                                                                     OperationFailedException

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

Parameters:

calendarId - the Id of the calendar

proxy - a proxy

Returns:

CyclicEventQuerySession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEventQuery() or supportsVisibleFederation() is false

Compliance:

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

getCyclicEventSearchSession

CyclicEventSearchSession getCyclicEventSearchSession(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the cyclic event search service.

Parameters:

proxy - a proxy

Returns:

an EventSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEventSearch() is false

Compliance:

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

getCyclicEventSearchSessionForCalendar

CyclicEventSearchSession getCyclicEventSearchSessionForCalendar(Id calendarId,
                                                              Proxy proxy)
                                                                throws NotFoundException,
                                                                       OperationFailedException

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

Parameters:

calendarId - the Id of the calendar

proxy - a proxy

Returns:

CyclicEventSearchSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEventSearch() or supportsVisibleFederation() is false

Compliance:

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

getCyclicEventAdminSession

CyclicEventAdminSession getCyclicEventAdminSession(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the cyclic event administration service.

Parameters:

proxy - a proxy

Returns:

an EventAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEventAdmin() is false

Compliance:

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

getCyclicEventAdminSessionForCalendar

CyclicEventAdminSession getCyclicEventAdminSessionForCalendar(Id calendarId,
                                                            Proxy proxy)
                                                              throws NotFoundException,
                                                                     OperationFailedException

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

Parameters:

calendarId - the Id of the calendar

proxy - a proxy

Returns:

CyclicEventAdminSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEventAdmin() or supportsVisibleFederation() is false

Compliance:

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

getCyclicEventNotificationSession

CyclicEventNotificationSession getCyclicEventNotificationSession(CyclicEventReceiver eventReceiver,
                                                               Proxy proxy)
                                                                 throws OperationFailedException

Gets the notification session for notifications pertaining to event changes.

Parameters:

eventReceiver - the cyclic event receiver

proxy - a proxy

Returns:

an EventNotificationSession

Throws:

NullArgumentException - eventReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEventNotification() is false

Compliance:

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

getCyclicEventNotificationSessionForCalendar

CyclicEventNotificationSession getCyclicEventNotificationSessionForCalendar(CyclicEventReceiver eventReceiver,
                                                                          Id calendarId,
                                                                          Proxy proxy)
                                                                            throws NotFoundException,
                                                                                   OperationFailedException

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

Parameters:

eventReceiver - the cyclic event receiver

calendarId - the Id of the calendar

proxy - a proxy

Returns:

CyclicEventNotificationSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - eventReceiver, calendarId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEventNotification() or supportsVisibleFederation() is false

Compliance:

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

getCyclicEventCalendarSession

CyclicEventCalendarSession getCyclicEventCalendarSession(Proxy proxy)
                                                         throws OperationFailedException

Gets the session for retrieving event to calendar mappings.

Parameters:

proxy - a proxy

Returns:

an EventCalendarSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEventCalendar() is false

Compliance:

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

getCyclicEventCalendarAssignmentSession

CyclicEventCalendarAssignmentSession getCyclicEventCalendarAssignmentSession(Proxy proxy)
                                                                             throws OperationFailedException

Gets the session for assigning event to calendar mappings.

Parameters:

proxy - a proxy

Returns:

an EventCalendarAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEventCalendarAssignment() is false

Compliance:

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

getCyclicEventSmartCalendarSession

CyclicEventSmartCalendarSession getCyclicEventSmartCalendarSession(Id calendarId,
                                                                 Proxy proxy)
                                                                   throws NotFoundException,
                                                                          OperationFailedException

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

Parameters:

calendarId - the Id of the calendar

proxy - a proxy

Returns:

an EventSmartCalendarSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEventSmartCalendar() is false

Compliance:

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

getEventCyclicEventLookupSession

EventCyclicEventLookupSession getEventCyclicEventLookupSession(Proxy proxy)
                                                               throws OperationFailedException

Gets the session for retrieving event to cyclic event associations.

Parameters:

proxy - a proxy

Returns:

an EventCyclicEventLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEventCyclicEventLookup() is false

Compliance:

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

getEventCyclicEventLookupSessionForCalendar

EventCyclicEventLookupSession getEventCyclicEventLookupSessionForCalendar(Id calendarId,
                                                                        Proxy proxy)
                                                                          throws NotFoundException,
                                                                                 OperationFailedException

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

Parameters:

calendarId - the Id of the calendar

proxy - a proxy

Returns:

an EventCyclicEventLookupSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEventCyclicEventLookup() or supportsVisibleFederation() is false

Compliance:

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

getEventCyclicEventAssignmentSession

EventCyclicEventAssignmentSession getEventCyclicEventAssignmentSession(Proxy proxy)
                                                                       throws OperationFailedException

Gets the session for manually making event to cyclic event associations.

Parameters:

proxy - a proxy

Returns:

an EventCyclicEventAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEventCyclicEventAssignment() is false

Compliance:

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

getEventCyclicEventAssignmentSessionForCalendar

EventCyclicEventAssignmentSession getEventCyclicEventAssignmentSessionForCalendar(Id calendarId,
                                                                                Proxy proxy)
                                                                                  throws NotFoundException,
                                                                                         OperationFailedException

Gets the OsidSession associated with the event cyclic event assignment service for the given calendar.

Parameters:

calendarId - the Id of the calendar

proxy - a proxy

Returns:

an EventCyclicEventAssignmentSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEventCyclicEventAssignment() or supportsVisibleFederation() is false

Compliance:

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

getCyclicTimePeriodLookupSession

CyclicTimePeriodLookupSession getCyclicTimePeriodLookupSession(Proxy proxy)
                                                               throws OperationFailedException

Gets the OsidSession associated with the cyclic time period lookup service.

Parameters:

proxy - a proxy

Returns:

a CyclicTimePeriodLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCyclicTimePeriodLookup() is false

Compliance:

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

getCyclicTimePeriodLookupSessionForCalendar

CyclicTimePeriodLookupSession getCyclicTimePeriodLookupSessionForCalendar(Id calendarId,
                                                                        Proxy proxy)
                                                                          throws NotFoundException,
                                                                                 OperationFailedException

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

Parameters:

calendarId - the Id of the calendar

proxy - a proxy

Returns:

a CyclicTimePeriodLookupSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCyclicTimePeriodLookup() or supportsVisibleFederation() is false

Compliance:

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

getCyclicTimePeriodQuerySession

CyclicTimePeriodQuerySession getCyclicTimePeriodQuerySession(Proxy proxy)
                                                             throws OperationFailedException

Gets the OsidSession associated with the cyclic time period query service.

Parameters:

proxy - a proxy

Returns:

a CyclicTimePeriodQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCyclicTimePeriodQuery() is false

Compliance:

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

getCyclicTimePeriodQuerySessionForCalendar

CyclicTimePeriodQuerySession getCyclicTimePeriodQuerySessionForCalendar(Id calendarId,
                                                                      Proxy proxy)
                                                                        throws NotFoundException,
                                                                               OperationFailedException

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

Parameters:

calendarId - the Id of the calendar

proxy - a proxy

Returns:

a CyclicTimePeriodQuerySession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCyclicTimePeriodQuery() or supportsVisibleFederation() is false

Compliance:

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

getCyclicTimePeriodSearchSession

CyclicTimePeriodSearchSession getCyclicTimePeriodSearchSession(Proxy proxy)
                                                               throws OperationFailedException

Gets the OsidSession associated with the cyclic time period search service.

Parameters:

proxy - a proxy

Returns:

a CyclicTimePeriodSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCyclicTimePeriodSearch() is false

Compliance:

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

getCyclicTimePeriodSearchSessionForCalendar

CyclicTimePeriodSearchSession getCyclicTimePeriodSearchSessionForCalendar(Id calendarId,
                                                                        Proxy proxy)
                                                                          throws NotFoundException,
                                                                                 OperationFailedException

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

Parameters:

calendarId - the Id of the calendar

proxy - a proxy

Returns:

a CyclicTimePeriodSearchSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCyclicTimePeriodSearch() or supportsVisibleFederation() is false

Compliance:

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

getCyclicTimePeriodAdminSession

CyclicTimePeriodAdminSession getCyclicTimePeriodAdminSession(Proxy proxy)
                                                             throws OperationFailedException

Gets the OsidSession associated with the cyclic time period administration service.

Parameters:

proxy - a proxy

Returns:

a CyclicTimePeriodAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCyclicTimePeriodAdmin() is false

Compliance:

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

getCyclicTimePeriodAdminSessionForCalendar

CyclicTimePeriodAdminSession getCyclicTimePeriodAdminSessionForCalendar(Id calendarId,
                                                                      Proxy proxy)
                                                                        throws NotFoundException,
                                                                               OperationFailedException

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

Parameters:

calendarId - the Id of the calendar

proxy - a proxy

Returns:

calendarId not found

Throws:

NotFoundException - a CyclicTimePeriodAdminSession

NullArgumentException - calendarId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCyclicTimePeriodAdmin() or supportsVisibleFederation() is false

Compliance:

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

getCyclicTimePeriodNotificationSession

CyclicTimePeriodNotificationSession getCyclicTimePeriodNotificationSession(CyclicTimePeriodReceiver cyclicTimePeriodReceiver,
                                                                         Proxy proxy)
                                                                           throws OperationFailedException

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

Parameters:

cyclicTimePeriodReceiver - the cyclic time period receiver

proxy - a proxy

Returns:

a CyclicTimePeriodNotificationSession

Throws:

NullArgumentException - cyclicTimePeriodReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCyclicTimePeriodNotification() is false

Compliance:

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

getCyclicTimePeriodNotificationSessionForCalendar

CyclicTimePeriodNotificationSession getCyclicTimePeriodNotificationSessionForCalendar(CyclicTimePeriodReceiver cyclicTimePeriodReceiver,
                                                                                    Id calendarId,
                                                                                    Proxy proxy)
                                                                                      throws NotFoundException,
                                                                                             OperationFailedException

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

Parameters:

cyclicTimePeriodReceiver - the cyclic time period receiver

calendarId - the Id of the calendar

proxy - a proxy

Returns:

a CyclicTimePeriodNotificationSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - cyclicTimePeriodReceiver or calendarId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCyclicTimePeriodNotification() or supportsVisibleFederation() is false

Compliance:

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

getCyclicTimePeriodCalendarSession

CyclicTimePeriodCalendarSession getCyclicTimePeriodCalendarSession(Proxy proxy)
                                                                   throws OperationFailedException

Gets the session for retrieving cyclic time period to calendar mappings.

Parameters:

proxy - a proxy

Returns:

a CyclicTimePeriodCalendarSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCyclicTimePeriodCalendar() is false

Compliance:

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

getCyclicTimePeriodCalendarAssignmentSession

CyclicTimePeriodCalendarAssignmentSession getCyclicTimePeriodCalendarAssignmentSession(Proxy proxy)
                                                                                       throws OperationFailedException

Gets the session for assigning cyclic time period to calendar mappings.

Parameters:

proxy - a proxy

Returns:

a CyclicTimePeriodCalendarAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCyclicTimePeriodCalendarAssignment() is false

Compliance:

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

getCyclicTimePeriodSmartCalendarSession

CyclicTimePeriodSmartCalendarSession getCyclicTimePeriodSmartCalendarSession(Id calendarId,
                                                                           Proxy proxy)
                                                                             throws NotFoundException,
                                                                                    OperationFailedException

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

Parameters:

calendarId - the Id of the calendar

proxy - a proxy

Returns:

a CyclicTimePeriodSmartCalendarSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCyclicTimePeriodSmartCalendar() is false

Compliance:

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

getTimePeriodCyclicTimePeriodLookupSession

TimePeriodCyclicTimePeriodLookupSession getTimePeriodCyclicTimePeriodLookupSession(Proxy proxy)
                                                                                   throws OperationFailedException

Gets the session for retrieving time period to cyclic time period associations.

Parameters:

proxy - a proxy

Returns:

a TimePeriodCyclicTimePeriodLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTimePeriodCyclicTimePeriodLookup() is false

Compliance:

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

getTimePeriodCyclicTimePeriodLookupSessionForCalendar

TimePeriodCyclicTimePeriodLookupSession getTimePeriodCyclicTimePeriodLookupSessionForCalendar(Id calendarId,
                                                                                            Proxy proxy)
                                                                                              throws NotFoundException,
                                                                                                     OperationFailedException

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

Parameters:

calendarId - the Id of the calendar

proxy - a proxy

Returns:

a TimePeriodCyclicTimePeriodLookupSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTimePeriodCyclicTimePeriodLookup() or supportsVisibleFederation() is false

Compliance:

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

getTimePeriodCyclicTimePeriodAssignmentSession

TimePeriodCyclicTimePeriodAssignmentSession getTimePeriodCyclicTimePeriodAssignmentSession(Proxy proxy)
                                                                                           throws OperationFailedException

Gets the session for manually making time period to cyclic time period associations.

Parameters:

proxy - a proxy

Returns:

a TimePeriodCyclicTimePeriodAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTimePeriodCyclicTimePeriodAssignment() is false

Compliance:

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

getTimePeriodCyclicTimePeriodAssignmentSessionForCalendar

TimePeriodCyclicTimePeriodAssignmentSession getTimePeriodCyclicTimePeriodAssignmentSessionForCalendar(Id calendarId,
                                                                                                    Proxy proxy)
                                                                                                      throws NotFoundException,
                                                                                                             OperationFailedException

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

Parameters:

calendarId - the Id of the calendar

proxy - a proxy

Returns:

a TimePeriodCyclicTimePeriodAssignmentSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTimePeriodCyclicTimePeriodAssignment() or supportsVisibleFederation() is false

Compliance:

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

getCalendaringCycleBatchProxyManager

CalendaringCycleBatchProxyManager getCalendaringCycleBatchProxyManager()
                                                                       throws OperationFailedException

Gets a CalendaringCycleBatchProxyManager.

Returns:

a CalendaringCycleBatchProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCalendaringCycleBatch() is false

Compliance:

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