Interface CalendaringCycleProxyManager

All Superinterfaces:

AutoCloseable, CalendaringCycleProfile, Closeable, OsidProfile, OsidProxyManager, 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
• 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
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 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 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 OsidProxyManager

close

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

Methods inherited from interface OsidProxyManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId, Proxy proxy)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime, Proxy proxy)	Rolls back this service to a point in time.

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(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 {@code supportsEventLookup()} is {@code 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 {@code supportsEventLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsEventQuery()} is {@code 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 {@code supportsEventQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsEventSearch()} is {@code 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 {@code supportsEventSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsEventAdmin()} is {@code 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 {@code supportsEventAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsEventNotification()} is {@code 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 {@code supportsEventNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsEventCalendar()} is {@code 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 {@code supportsEventCalendarAssignment()} is {@code 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 {@code supportsEventSmartCalendar()} is {@code 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 {@code supportsEventCyclicEventLookup()} is {@code 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 {@code supportsEventCyclicEventLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsEventCyclicEventAssignment()} is {@code 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 {@code supportsEventCyclicEventAssignment()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsCyclicTimePeriodLookup()} is {@code 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 {@code supportsCyclicTimePeriodLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsCyclicTimePeriodQuery()} is {@code 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 {@code supportsCyclicTimePeriodQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsCyclicTimePeriodSearch()} is {@code 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 {@code supportsCyclicTimePeriodSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsCyclicTimePeriodAdmin()} is {@code 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 {@code supportsCyclicTimePeriodAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsCyclicTimePeriodNotification()} is {@code 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 {@code supportsCyclicTimePeriodNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsCyclicTimePeriodCalendar()} is {@code 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 {@code supportsCyclicTimePeriodCalendarAssignment()} is {@code 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 {@code supportsCyclicTimePeriodSmartCalendar()} is {@code 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 {@code supportsTimePeriodCyclicTimePeriodLookup()} is {@code 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 {@code supportsTimePeriodCyclicTimePeriodLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsTimePeriodCyclicTimePeriodAssignment()} is {@code 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 {@code supportsTimePeriodCyclicTimePeriodAssignment()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsCalendaringCycleBatch()} is {@code true} .