OSID Logo
OSID Specifications
calendaring cycle batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.cycle.batch.CalendaringCycleBatchProxyManager
Implementsosid.OsidProxyManager
osid.calendaring.cycle.batch.CalendaringCycleBatchProfile
Description

The calendaring cycle batch proxy manager provides access to calendaring cycle batch 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:

  • CyclicEventBatchAdminSession: a session to create, modify and delete cyclic events in bulk
  • CyclicTimePeriodBatchSession: a session to create, modify and delete cyclic time periods in bulk
MethodgetCyclicEventBatchAdminSession
Description

Gets the OsidSession associated with the bulk cyclic event administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.calendaring.cycle.batch.CyclicEventBatchAdminSessiona CyclicEventBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCyclicEventBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsCyclicEventBatchAdmin() is true.
MethodgetCyclicEventBatchAdminSessionForCalendar
Description

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

Parametersosid.id.IdcalendarIdthe Id of the Calendar
osid.proxy.Proxyproxya proxy
Returnosid.calendaring.cycle.batch.CyclicEventBatchAdminSessiona CyclicEventBatchAdminSession
ErrorsNOT_FOUNDno Calendar found by the given Id
NULL_ARGUMENT calendarId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCyclicEventBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCyclicEventBatchAdmin() and supportsVisibleFederation() are true
MethodgetCyclicTimePeriodBatchAdminSession
Description

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

Parametersosid.proxy.Proxyproxya proxy
Returnosid.calendaring.cycle.batch.CyclicTimePeriodBatchAdminSessiona CyclicTimePeriodBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCyclicTimePeriodBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsCyclicTimePeriodBatchAdmin() is true.
MethodgetCyclicTimePeriodBatchAdminSessionForCalendar
Description

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

Parametersosid.id.IdcalendarIdthe Id of the Calendar
osid.proxy.Proxyproxya proxy
Returnosid.calendaring.cycle.batch.CyclicTimePeriodBatchAdminSessiona CyclicTimePeriodBatchAdminSession
ErrorsNOT_FOUNDno Calendar found by the given Id
NULL_ARGUMENT calendarId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCyclicTimePeriodBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCyclicTimePeriodBatchAdmin() and supportsVisibleFederation() are true