OSID Logo
OSID Specifications
calendaring batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.batch.CalendaringBatchProxyManager
Implementsosid.OsidProxyManager
osid.calendaring.batch.CalendaringBatchProfile
Description

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

  • EventBatchAdminSession: a session to create, modify and delete events in bulk
  • RecurringEventBatchAdminSession: a session to create, modify and delete recurring events in bulk
  • OffsetEventBatchSession: a session to create, modify and delete offset events in bulk
  • ScheduleBatchAdminSession: a session to create, modify and delete schedules in bulk
  • ScheduleSlotBatchSession: a session to create, modify and delete schedule slots in bulk
  • CommitmentBatchAdminSession: a session to create, modify and delete commitments in bulk
  • TimePeriodBatchAdminSession: a session to create, modify and delete time periods in bulk
  • CalendarBatchAdminSession: a session to create, modify and delete calendars in bulk
MethodgetEventBatchAdminSession
Description

Gets the OsidSession associated with the bulk event administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.calendaring.batch.EventBatchAdminSessionan EventBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEventBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsEventBatchAdmin() is true.
MethodgetEventBatchAdminSessionForCalendar
Description

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

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

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

Parametersosid.proxy.Proxyproxya proxy
Returnosid.calendaring.batch.RecurringEventBatchAdminSessiona RecurringEventBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRecurringEventBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsRecurringEventBatchAdmin() is true.
MethodgetRecurringEventBatchAdminSessionForCalendar
Description

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

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

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

Parametersosid.proxy.Proxyproxya proxy
Returnosid.calendaring.batch.OffsetEventBatchAdminSessionan OffsetEventBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsOffsetEventBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsOffsetEventBatchAdmin() is true.
MethodgetOffsetEventBatchAdminSessionForCalendar
Description

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

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

Gets the OsidSession associated with the bulk schedule administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.calendaring.batch.ScheduleBatchAdminSessiona ScheduleBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsScheduleBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsScheduleBatchAdmin() is true.
MethodgetScheduleBatchAdminSessionForCalendar
Description

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

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

Gets the OsidSession associated with the bulk schedule slot administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.calendaring.batch.ScheduleSlotBatchAdminSessiona ScheduleSlotBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsScheduleSlotBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsScheduleSlotBatchAdmin() is true.
MethodgetScheduleSlotBatchAdminSessionForCalendar
Description

Gets the OsidSession associated with the bulk schedule slot administration service for the given calendar.

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

Gets the OsidSession associated with the bulk commitment administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.calendaring.batch.CommitmentBatchAdminSessiona CommitmentBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCommitmentBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsCommitmentBatchAdmin() is true.
MethodgetCommitmentBatchAdminSessionForCalendar
Description

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

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

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

Parametersosid.proxy.Proxyproxya proxy
Returnosid.calendaring.batch.TimePeriodBatchAdminSessiona TimePeriodBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTimePeriodBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsTimePeriodBatchAdmin() is true.
MethodgetTimePeriodBatchAdminSessionForCalendar
Description

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

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

Gets the OsidSession associated with the bulk calendar administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.calendaring.batch.CalendarBatchAdminSessiona CalendarBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCalendarBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsCalendarBatchAdmin() is true.