OSID - osid.calendaring.batch.CalendaringBatchManager Service Interface Definition

Interface	osid.calendaring.batch.CalendaringBatchManager
Implements	`osid.OsidManager`
Implements	`osid.calendaring.batch.CalendaringBatchProfile`
Description	The calendaring batch manager provides access to calendaring batch sessions and provides interoperability tests for various aspects of this service. 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
Method	getEventBatchAdminSession
Description	Gets the `OsidSession` associated with the bulk event administration service.
Return	`osid.calendaring.batch.EventBatchAdminSession`		an `EventBatchAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsEventBatchAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEventBatchAdmin()` is `true.`
Method	getEventBatchAdminSessionForCalendar
Description	Gets the `OsidSession` associated with the bulk event administration service for the given calendar.
Parameters	`osid.id.Id`	`calendarId`	the `Id` of the `Calendar`
Return	`osid.calendaring.batch.EventBatchAdminSession`		an `EventBatchAdminSession`
Errors	NOT_FOUND		no `Calendar` found by the given `Id`
	NULL_ARGUMENT		`calendarId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsEventBatchAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEventBatchAdmin()` and `supportsVisibleFederation()` are `true`
Method	getRecurringEventBatchAdminSession
Description	Gets the `OsidSession` associated with the bulk recurring event administration service.
Return	`osid.calendaring.batch.RecurringEventBatchAdminSession`		a `RecurringEventBatchAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsRecurringEventBatchAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRecurringEventBatchAdmin()` is `true.`
Method	getRecurringEventBatchAdminSessionForCalendar
Description	Gets the `OsidSession` associated with the bulk recurring event administration service for the given calendar.
Parameters	`osid.id.Id`	`calendarId`	the `Id` of the `Calendar`
Return	`osid.calendaring.batch.RecurringEventBatchAdminSession`		a `RecurringEventBatchAdminSession`
Errors	NOT_FOUND		no `Calendar` found by the given `Id`
	NULL_ARGUMENT		`calendarId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRecurringEventBatchAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRecurringEventBatchAdmin()` and `supportsVisibleFederation()` are `true`
Method	getOffsetEventBatchAdminSession
Description	Gets the `OsidSession` associated with the bulk offset event administration service.
Return	`osid.calendaring.batch.OffsetEventBatchAdminSession`		an `OffsetEventBatchAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsOffsetEventBatchAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsOffsetEventBatchAdmin()` is `true.`
Method	getOffsetEventBatchAdminSessionForCalendar
Description	Gets the `OsidSession` associated with the bulk offset event administration service for the given calendar
Parameters	`osid.id.Id`	`calendarId`	the `Id` of the `Calendar`
Return	`osid.calendaring.batch.OffsetEventBatchAdminSession`		an `OffsetEventBatchAdminSession`
Errors	NOT_FOUND		no `Calendar` found by the given `Id`
	NULL_ARGUMENT		`calendarId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsOffsetEventBatchAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsOffsetEventBatchAdmin()` and `supportsVisibleFederation()` are `true`
Method	getScheduleBatchAdminSession
Description	Gets the `OsidSession` associated with the bulk schedule administration service.
Return	`osid.calendaring.batch.ScheduleBatchAdminSession`		a `ScheduleBatchAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsScheduleBatchAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsScheduleBatchAdmin()` is `true.`
Method	getScheduleBatchAdminSessionForCalendar
Description	Gets the `OsidSession` associated with the bulk schedule administration service for the given calendar.
Parameters	`osid.id.Id`	`calendarId`	the `Id` of the `Calendar`
Return	`osid.calendaring.batch.ScheduleBatchAdminSession`		a `ScheduleBatchAdminSession`
Errors	NOT_FOUND		no `Calendar` found by the given `Id`
	NULL_ARGUMENT		`calendarId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsScheduleBatchAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsScheduleBatchAdmin()` and `supportsVisibleFederation()` are `true`
Method	getScheduleSlotBatchAdminSession
Description	Gets the `OsidSession` associated with the bulk schedule slot administration service.
Return	`osid.calendaring.batch.ScheduleSlotBatchAdminSession`		a `ScheduleSlotBatchAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsScheduleSlotBatchAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsScheduleSlotBatchAdmin()` is `true.`
Method	getScheduleSlotBatchAdminSessionForCalendar
Description	Gets the `OsidSession` associated with the bulk schedule slot administration service for the given calendar.
Parameters	`osid.id.Id`	`calendarId`	the `Id` of the `Calendar`
Return	`osid.calendaring.batch.ScheduleSlotBatchAdminSession`		a `ScheduleSlotBatchAdminSession`
Errors	NOT_FOUND		no `Calendar` found by the given `Id`
	NULL_ARGUMENT		`calendarId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsScheduleSlotBatchAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsScheduleSlotBatchAdmin()` and `supportsVisibleFederation()` are `true`
Method	getCommitmentBatchAdminSession
Description	Gets the `OsidSession` associated with the bulk commitment administration service.
Return	`osid.calendaring.batch.CommitmentBatchAdminSession`		a `CommitmentBatchAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsCommitmentBatchAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCommitmentBatchAdmin()` is `true.`
Method	getCommitmentBatchAdminSessionForCalendar
Description	Gets the `OsidSession` associated with the bulk commitment administration service for the given calendar.
Parameters	`osid.id.Id`	`calendarId`	the `Id` of the `Calendar`
Return	`osid.calendaring.batch.CommitmentBatchAdminSession`		a `CommitmentBatchAdminSession`
Errors	NOT_FOUND		no `Calendar` found by the given `Id`
	NULL_ARGUMENT		`calendarId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsCommitmentBatchAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCommitmentBatchAdmin()` and `supportsVisibleFederation()` are `true`
Method	getTimePeriodBatchAdminSession
Description	Gets the `OsidSession` associated with the bulk time period administration service.
Return	`osid.calendaring.batch.TimePeriodBatchAdminSession`		a `TimePeriodBatchAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsTimePeriodBatchAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsTimePeriodBatchAdmin()` is `true.`
Method	getTimePeriodBatchAdminSessionForCalendar
Description	Gets the `OsidSession` associated with the bulk time period administration service for the given calendar.
Parameters	`osid.id.Id`	`calendarId`	the `Id` of the `Calendar`
Return	`osid.calendaring.batch.TimePeriodBatchAdminSession`		a `TimePeriodBatchAdminSession`
Errors	NOT_FOUND		no `Calendar` found by the given `Id`
	NULL_ARGUMENT		`calendarId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsTimePeriodBatchAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsTimePeriodBatchAdmin()` and `supportsVisibleFederation()` are `true`
Method	getCalendarBatchAdminSession
Description	Gets the `OsidSession` associated with the bulk calendar administration service.
Return	`osid.calendaring.batch.CalendarBatchAdminSession`		a `CalendarBatchAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsCalendarBatchAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCalendarBatchAdmin()` is `true.`