OSID Logo
OSID Specifications
calendaring cycle batch package
Version 3.1.0
Interfaceosid.calendaring.cycle.batch.CalendaringCycleBatchManager
Implementsosid.OsidManager
osid.calendaring.cycle.batch.CalendaringCycleBatchProfile
Used Byosid.calendaring.cycle.CalendaringCycleManager
Description

The calendaring cycle batch manager provides access to calendaring cycle batch sessions and provides interoperability tests for various aspects of this service. 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.

Returnosid.calendaring.cycle.batch.CyclicEventBatchAdminSession a CyclicEventBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCyclicEventBatchAdmin() is false
Complianceoptional This 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.IdcalendarId the Id of the Calendar
Returnosid.calendaring.cycle.batch.CyclicEventBatchAdminSession a CyclicEventBatchAdminSession
ErrorsNOT_FOUND no Calendar found by the given Id
NULL_ARGUMENT calendarId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCyclicEventBatchAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsCyclicEventBatchAdmin() and supportsVisibleFederation() are true
MethodgetCyclicTimePeriodBatchAdminSession
Description

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

Returnosid.calendaring.cycle.batch.CyclicTimePeriodBatchAdminSession a CyclicTimePeriodBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCyclicTimePeriodBatchAdmin() is false
Complianceoptional This 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.IdcalendarId the Id of the Calendar
Returnosid.calendaring.cycle.batch.CyclicTimePeriodBatchAdminSession a CyclicTimePeriodBatchAdminSession
ErrorsNOT_FOUND no Calendar found by the given Id
NULL_ARGUMENT calendarId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCyclicTimePeriodBatchAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsCyclicTimePeriodBatchAdmin() and supportsVisibleFederation() are true