Interface CalendaringCycleManager

All Superinterfaces:

AutoCloseable, CalendaringCycleProfile, Closeable, OsidManager, OsidManager, OsidProfile, Sourceable

public interface CalendaringCycleManager
extends OsidManager, CalendaringCycleProfile

The calendaring cycle manager provides access to calendaring cycle sessions and provides interoperability tests for various aspects of this service. 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
• EventCyclicEventLookupSession : a session to look up the associations between events and cyclic events
• EventCyclicEventAssignmentSession : a session to manually map events to cyclic events

• 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
• TimePeriodCyclicTimePeriodLookupSession : a session to look up the associations between time periods and cyclic time periods
• TimePeriodCyclicTimePeriodAssignmentSession : a session to manually map time periods to cyclic time periods

Method Summary

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

Methods inherited from interface 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

Modifier and Type	Method	Description
TypeList	getCyclicEventRecordTypes()	Gets the supported CyclicEvent record types.
TypeList	getCyclicEventSearchRecordTypes()	Gets the supported CyclicEvent search record types.
TypeList	getCyclicTimePeriodRecordTypes()	Gets the supported CyclicTimePeriod record types.
TypeList	getCyclicTimePeriodSearchRecordTypes()	Gets the supported CyclicTimePeriod search record types.
boolean	supportsCalendaringCycleBatch()	Tests if a calendaring cycle batch service is available.
boolean	supportsCyclicEventAdmin()	Tests if a cyclic event administrative service is supported.
boolean	supportsCyclicEventCalendar()	Tests if a cyclic event to calendar lookup session is available.
boolean	supportsCyclicEventCalendarAssignment()	Tests if a cyclic event to calendar assignment session is available.
boolean	supportsCyclicEventLookup()	Tests if a cyclic event lookup service is supported.
boolean	supportsCyclicEventNotification()	Tests if cyclic event notification is supported.
boolean	supportsCyclicEventQuery()	Tests if a cyclic event query service is supported.
boolean	supportsCyclicEventRecordType(Type cyclicEventRecordType)	Tests if the given CyclicEvent record type is supported.
boolean	supportsCyclicEventSearch()	Tests if a cyclic event search service is supported.
boolean	supportsCyclicEventSearchRecordType(Type cyclicEventSearchRecordType)	Tests if the given CyclicEvent search record type is supported.
boolean	supportsCyclicEventSmartCalendar()	Tests if cyclic event smart calendaring is available.
boolean	supportsCyclicTimePeriodAdmin()	Tests if a cyclic time period administrative service is supported.
boolean	supportsCyclicTimePeriodCalendar()	Tests if a cyclic time period to calendar lookup session is available.
boolean	supportsCyclicTimePeriodCalendarAssignment()	Tests if a cyclic time period to calendar assignment session is available.
boolean	supportsCyclicTimePeriodLookup()	Tests if a cyclic time period lookup service is supported.
boolean	supportsCyclicTimePeriodNotification()	Tests if cyclic time period notification is supported.
boolean	supportsCyclicTimePeriodRecordType(Type cyclicTimePeriodRecordType)	Tests if the given CyclicTimePeriod record type is supported.
boolean	supportsCyclicTimePeriodSearch()	Tests if a cyclic time period search service is supported.
boolean	supportsCyclicTimePeriodSearchRecordType(Type cyclicTimePeriodSearchRecordType)	Tests if the given CyclicTimePeriod search record type is supported.
boolean	supportsCyclicTimePeriodSmartCalendar()	Tests if cyclic time period smart calendaring is available.
boolean	supportsEventCyclicEventAssignment()	Tests if a session for manually assigning events to cyclic events is available.
boolean	supportsEventCyclicEventLookup()	Tests if a session to look up associations between events and cyclic events is available.
boolean	supportsTimePeriodCyclicTimePeriodAssignment()	Tests if a session for manually assigning time periods to cyclic time periods is available.
boolean	supportsTimePeriodCyclicTimePeriodLookup()	Tests if a session to look up associations between time periods and cyclic time periods is available.
boolean	supportsVisibleFederation()	Tests if federation is visible.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	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, supportsProxyRecordType

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

getCyclicEventLookupSession

CyclicEventLookupSession getCyclicEventLookupSession()
                                              throws OperationFailedException

Gets the OsidSession associated with the cyclic event lookup service.

Returns:

a CyclicEventLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCyclicEventLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsCyclicEventLookup()} is {@code true} .

getCyclicEventLookupSessionForCalendar

CyclicEventLookupSession getCyclicEventLookupSessionForCalendar(Id calendarId)
                                                         throws NotFoundException,
OperationFailedException

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

Parameters:

calendarId - the Id of the calendar

Returns:

a CyclicEventLookupSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCyclicEventLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsCyclicEventLookup()} and {@code supportsVisibleFederation()} are {@code true} .

getCyclicEventQuerySession

CyclicEventQuerySession getCyclicEventQuerySession()
                                            throws OperationFailedException

Gets the OsidSession associated with the cyclic event query service.

Returns:

a CyclicEventQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCyclicEventQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsCyclicEventQuery()} is {@code true} .

getCyclicEventQuerySessionForCalendar

CyclicEventQuerySession getCyclicEventQuerySessionForCalendar(Id calendarId)
                                                       throws NotFoundException,
OperationFailedException

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

Parameters:

calendarId - the Id of the calendar

Returns:

a CyclicEventQuerySession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCyclicEventQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsCyclicEventQuery()} and {@code supportsVisibleFederation()} are {@code true} .

getCyclicEventSearchSession

CyclicEventSearchSession getCyclicEventSearchSession()
                                              throws OperationFailedException

Gets the OsidSession associated with the cyclic event search service.

Returns:

a CyclicEventSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCyclicEventSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsCyclicEventSearch()} is {@code true} .

getCyclicEventSearchSessionForCalendar

CyclicEventSearchSession getCyclicEventSearchSessionForCalendar(Id calendarId)
                                                         throws NotFoundException,
OperationFailedException

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

Parameters:

calendarId - the Id of the calendar

Returns:

a CyclicEventSearchSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCyclicEventSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsCyclicEventSearch()} and {@code supportsVisibleFederation()} are {@code true} .

getCyclicEventAdminSession

CyclicEventAdminSession getCyclicEventAdminSession()
                                            throws OperationFailedException

Gets the OsidSession associated with the cyclic event administration service.

Returns:

a CyclicEventAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCyclicEventAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsCyclicEventAdmin()} is {@code true} .

getCyclicEventAdminSessionForCalendar

CyclicEventAdminSession getCyclicEventAdminSessionForCalendar(Id calendarId)
                                                       throws NotFoundException,
OperationFailedException

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

Parameters:

calendarId - the Id of the calendar

Returns:

a CyclicEventAdminSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCyclicEventAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsCyclicEventAdmin()} and {@code supportsVisibleFederation()} are {@code true} .

getCyclicEventNotificationSession

CyclicEventNotificationSession getCyclicEventNotificationSession(CyclicEventReceiver cyclicEventReceiver)
                                                          throws OperationFailedException

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

Parameters:

cyclicEventReceiver - the cyclic event receiver

Returns:

a CyclicEventNotificationSession

Throws:

NullArgumentException - cyclicEventReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCyclicEventNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsCyclicEventNotification()} is {@code true} .

getCyclicEventNotificationSessionForCalendar

CyclicEventNotificationSession getCyclicEventNotificationSessionForCalendar(CyclicEventReceiver cyclicEventReceiver,
 Id calendarId)
                                                                     throws NotFoundException,
OperationFailedException

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

Parameters:

cyclicEventReceiver - the cyclic event receiver

calendarId - the Id of the calendar

Returns:

a CyclicEventNotificationSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - cyclicEventReceiver or calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCyclicEventNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsCyclicEventNotification()} and {@code supportsVisibleFederation()} are {@code true} .

getCyclicEventCalendarSession

CyclicEventCalendarSession getCyclicEventCalendarSession()
                                                  throws OperationFailedException

Gets the session for retrieving cyclic event to calendar mappings.

Returns:

a CyclicEventCalendarSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCyclicEventCalendar() is false

Compliance:

optional - This method must be implemented if {@code supportsCyclicEventCalendar()} is {@code true} .

getCyclicEventCalendarAssignmentSession

CyclicEventCalendarAssignmentSession getCyclicEventCalendarAssignmentSession()
                                                                      throws OperationFailedException

Gets the session for assigning event to calendar mappings.

Returns:

a CyclicEventCalendarAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCyclicEventCalendarAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsCyclicEventCalendarAssignment()} is {@code true} .

getCyclicEventSmartCalendarSession

CyclicEventSmartCalendarSession getCyclicEventSmartCalendarSession(Id calendarId)
                                                            throws NotFoundException,
OperationFailedException

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

Parameters:

calendarId - the Id of the calendar

Returns:

a CyclicEventSmartCalendarSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCyclicEventSmartCalendar() is false

Compliance:

optional - This method must be implemented if {@code supportsCyclicEventSmartCalendar()} is {@code true} .

getEventCyclicEventLookupSession

EventCyclicEventLookupSession getEventCyclicEventLookupSession()
                                                        throws OperationFailedException

Gets the session for retrieving event to cyclic event associations.

Returns:

an EventCyclicEventLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEventCyclicEventLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsEventCyclicEventLookup()} is {@code true} .

getEventCyclicEventLookupSessionForCalendar

EventCyclicEventLookupSession getEventCyclicEventLookupSessionForCalendar(Id calendarId)
                                                                   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

Returns:

an EventCyclicEventLookupSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEventCyclicEventLookup() or supportsVisibleFederation() is false

Compliance:

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

getEventCyclicEventAssignmentSession

EventCyclicEventAssignmentSession getEventCyclicEventAssignmentSession()
                                                                throws OperationFailedException

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

Returns:

an EventCyclicEventAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEventCyclicEventAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsEventCyclicEventAssignment()} is {@code true} .

getEventCyclicEventAssignmentSessionForCalendar

EventCyclicEventAssignmentSession getEventCyclicEventAssignmentSessionForCalendar(Id calendarId)
                                                                           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

Returns:

an EventCyclicEventAssignmentSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEventCyclicEventAssignment() or supportsVisibleFederation() is false

Compliance:

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

getCyclicTimePeriodLookupSession

CyclicTimePeriodLookupSession getCyclicTimePeriodLookupSession()
                                                        throws OperationFailedException

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

Returns:

a CyclicTimePeriodLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCyclicTimePeriodLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsCyclicTimePeriodLookup()} is {@code true} .

getCyclicTimePeriodLookupSessionForCalendar

CyclicTimePeriodLookupSession getCyclicTimePeriodLookupSessionForCalendar(Id calendarId)
                                                                   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

Returns:

a CyclicTimePeriodLookupSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCyclicTimePeriodLookup() or supportsVisibleFederation() is false

Compliance:

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

getCyclicTimePeriodQuerySession

CyclicTimePeriodQuerySession getCyclicTimePeriodQuerySession()
                                                      throws OperationFailedException

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

Returns:

a CyclicTimePeriodQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCyclicTimePeriodQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsCyclicTimePeriodQuery()} is {@code true} .

getCyclicTimePeriodQuerySessionForCalendar

CyclicTimePeriodQuerySession getCyclicTimePeriodQuerySessionForCalendar(Id calendarId)
                                                                 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

Returns:

a CyclicTimePeriodQuerySession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCyclicTimePeriodQuery() or supportsVisibleFederation() is false

Compliance:

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

getCyclicTimePeriodSearchSession

CyclicTimePeriodSearchSession getCyclicTimePeriodSearchSession()
                                                        throws OperationFailedException

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

Returns:

a CyclicTimePeriodSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCyclicTimePeriodSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsCyclicTimePeriodSearch()} is {@code true} .

getCyclicTimePeriodSearchSessionForCalendar

CyclicTimePeriodSearchSession getCyclicTimePeriodSearchSessionForCalendar(Id calendarId)
                                                                   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

Returns:

a CyclicTimePeriodSearchSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCyclicTimePeriodSearch() or supportsVisibleFederation() is false

Compliance:

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

getCyclicTimePeriodAdminSession

CyclicTimePeriodAdminSession getCyclicTimePeriodAdminSession()
                                                      throws OperationFailedException

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

Returns:

a CyclicTimePeriodAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCyclicTimePeriodAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsCyclicTimePeriodAdmin()} is {@code true} .

getCyclicTimePeriodAdminSessionForCalendar

CyclicTimePeriodAdminSession getCyclicTimePeriodAdminSessionForCalendar(Id calendarId)
                                                                 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

Returns:

a CyclicTimePeriodAdminSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCyclicTimePeriodAdmin() or supportsVisibleFederation() is false

Compliance:

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

getCyclicTimePeriodNotificationSession

CyclicTimePeriodNotificationSession getCyclicTimePeriodNotificationSession(CyclicTimePeriodReceiver cyclicTimePeriodReceiver)
                                                                    throws OperationFailedException

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

Parameters:

cyclicTimePeriodReceiver - the cyclic time period receiver

Returns:

a CyclicTimePeriodNotificationSession

Throws:

NullArgumentException - cyclicTimePeriodReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCyclicTimePeriodNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsCyclicTimePeriodNotification()} is {@code true} .

getCyclicTimePeriodNotificationSessionForCalendar

CyclicTimePeriodNotificationSession getCyclicTimePeriodNotificationSessionForCalendar(CyclicTimePeriodReceiver cyclicTimePeriodReceiver,
 Id calendarId)
                                                                               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

Returns:

a CyclicTimePeriodNotificationSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - cyclicTimePeriodReceiver or calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCyclicTimePeriodNotification() or supportsVisibleFederation() is false

Compliance:

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

getCyclicTimePeriodCalendarSession

CyclicTimePeriodCalendarSession getCyclicTimePeriodCalendarSession()
                                                            throws OperationFailedException

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

Returns:

a CyclicTimePeriodCalendarSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCyclicTimePeriodCalendar() is false

Compliance:

optional - This method must be implemented if {@code supportsCyclicTimePeriodCalendar()} is {@code true} .

getCyclicTimePeriodCalendarAssignmentSession

CyclicTimePeriodCalendarAssignmentSession getCyclicTimePeriodCalendarAssignmentSession()
                                                                                throws OperationFailedException

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

Returns:

a CyclicTimePeriodCalendarAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCyclicTimePeriodCalendarAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsCyclicTimePeriodCalendarAssignment()} is {@code true} .

getCyclicTimePeriodSmartCalendarSession

CyclicTimePeriodSmartCalendarSession getCyclicTimePeriodSmartCalendarSession(Id calendarId)
                                                                      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

Returns:

a CyclicTimePeriodSmartCalendarSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCyclicTimePeriodSmartCalendar() is false

Compliance:

optional - This method must be implemented if {@code supportsCyclicTimePeriodSmartCalendar()} is {@code true} .

getTimePeriodCyclicTimePeriodLookupSession

TimePeriodCyclicTimePeriodLookupSession getTimePeriodCyclicTimePeriodLookupSession()
                                                                            throws OperationFailedException

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

Returns:

a TimePeriodCyclicTimePeriodLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTimePeriodCyclicTimePeriodLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsTimePeriodCyclicTimePeriodLookup()} is {@code true} .

getTimePeriodCyclicTimePeriodLookupSessionForCalendar

TimePeriodCyclicTimePeriodLookupSession getTimePeriodCyclicTimePeriodLookupSessionForCalendar(Id calendarId)
                                                                                       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

Returns:

a TimePeriodCyclicTimePeriodLookupSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTimePeriodCyclicTimePeriodLookup() or supportsVisibleFederation() is false

Compliance:

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

getTimePeriodCyclicTimePeriodAssignmentSession

TimePeriodCyclicTimePeriodAssignmentSession getTimePeriodCyclicTimePeriodAssignmentSession()
                                                                                    throws OperationFailedException

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

Returns:

a TimePeriodCyclicTimePeriodAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTimePeriodCyclicTimePeriodAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsTimePeriodCyclicTimePeriodAssignment()} is {@code true} .

getTimePeriodCyclicTimePeriodAssignmentSessionForCalendar

TimePeriodCyclicTimePeriodAssignmentSession getTimePeriodCyclicTimePeriodAssignmentSessionForCalendar(Id calendarId)
                                                                                               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

Returns:

a TimePeriodCyclicTimePeriodAssignmentSession

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTimePeriodCyclicTimePeriodAssignment() or supportsVisibleFederation() is false

Compliance:

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

getCalendaringCycleBatchManager

CalendaringCycleBatchManager getCalendaringCycleBatchManager()
                                                      throws OperationFailedException

Gets a CalendaringCycleBatchManager .

Returns:

a CalendaringCycleBatchManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCalendaringCycleBatch() is false

Compliance:

optional - This method must be implemented if {@code supportsCalendaringCycleBatch()} is {@code true} .