| Interface | osid.calendaring.batch.CalendaringBatchProxyManager | ||
|---|---|---|---|
| Implements | osid.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  
  | ||
| Method | getEventBatchAdminSession | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy | 
| Return | osid.calendaring.batch.EventBatchAdminSession | an  EventBatchAdminSession   | |
| Errors | NULL_ARGUMENT |  proxy  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsEventBatchAdmin()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsEventBatchAdmin()  
is  true.   | |
| Method | getEventBatchAdminSessionForCalendar | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.id.Id | calendarId | the  Id  of the  Calendar   | 
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.calendaring.batch.EventBatchAdminSession | a  EventBatchAdminSession   | |
| Errors | NOT_FOUND | no  Calendar  found by the given  Id   |                 |
| NULL_ARGUMENT |  calendarId  or  proxy  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   | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy | 
| Return | osid.calendaring.batch.RecurringEventBatchAdminSession | a  RecurringEventBatchAdminSession   | |
| Errors | NULL_ARGUMENT |  proxy  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsRecurringEventBatchAdmin()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  
supportsRecurringEventBatchAdmin()  is  true.   | |
| Method | getRecurringEventBatchAdminSessionForCalendar | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.id.Id | calendarId | the  Id  of the  Calendar   | 
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.calendaring.batch.RecurringEventBatchAdminSession | a  RecurringEventBatchAdminSession   | |
| Errors | NOT_FOUND | no  Calendar  found by the given  Id   |                 |
| NULL_ARGUMENT |  calendarId  or  proxy  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   | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy | 
| Return | osid.calendaring.batch.OffsetEventBatchAdminSession | an  OffsetEventBatchAdminSession   | |
| Errors | NULL_ARGUMENT |  proxy  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsOffsetEventBatchAdmin()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsOffsetEventBatchAdmin() 
 is  true.   | |
| Method | getOffsetEventBatchAdminSessionForCalendar | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.id.Id | calendarId | the  Id  of the  Calendar   | 
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.calendaring.batch.OffsetEventBatchAdminSession | an  OffsetEventBatchAdminSession   | |
| Errors | NOT_FOUND | no  Calendar  found by the given  Id   |                 |
| NULL_ARGUMENT |  calendarId  or  proxy  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   | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy | 
| Return | osid.calendaring.batch.ScheduleBatchAdminSession | a  ScheduleBatchAdminSession   | |
| Errors | NULL_ARGUMENT |  proxy  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsScheduleBatchAdmin()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsScheduleBatchAdmin() 
 is  true.   | |
| Method | getScheduleBatchAdminSessionForCalendar | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.id.Id | calendarId | the  Id  of the  Calendar   | 
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.calendaring.batch.ScheduleBatchAdminSession | a  ScheduleBatchAdminSession   | |
| Errors | NOT_FOUND | no  Calendar  found by the given  Id   |                 |
| NULL_ARGUMENT |  calendarId  or  proxy  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   | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy | 
| Return | osid.calendaring.batch.ScheduleSlotBatchAdminSession | a  ScheduleSlotBatchAdminSession   | |
| Errors | NULL_ARGUMENT |  proxy  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsScheduleSlotBatchAdmin()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsScheduleSlotBatchAdmin() 
 is  true.   | |
| Method | getScheduleSlotBatchAdminSessionForCalendar | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.id.Id | calendarId | the  Id  of the  Calendar   | 
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.calendaring.batch.ScheduleSlotBatchAdminSession | a  ScheduleSlotBatchAdminSession   | |
| Errors | NOT_FOUND | no  Calendar  found by the given  Id   |                 |
| NULL_ARGUMENT |  calendarId  or  proxy  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   | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy | 
| Return | osid.calendaring.batch.CommitmentBatchAdminSession | a  CommitmentBatchAdminSession   | |
| Errors | NULL_ARGUMENT |  proxy  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsCommitmentBatchAdmin()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsCommitmentBatchAdmin() 
 is  true.   | |
| Method | getCommitmentBatchAdminSessionForCalendar | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.id.Id | calendarId | the  Id  of the  Calendar   | 
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.calendaring.batch.CommitmentBatchAdminSession | a  CommitmentBatchAdminSession   | |
| Errors | NOT_FOUND | no  Calendar  found by the given  Id   |                 |
| NULL_ARGUMENT |  calendarId  or  proxy  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   | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy | 
| Return | osid.calendaring.batch.TimePeriodBatchAdminSession | a  TimePeriodBatchAdminSession   | |
| Errors | NULL_ARGUMENT |  proxy  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsTimePeriodBatchAdmin()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsTimePeriodBatchAdmin() 
 is  true.   | |
| Method | getTimePeriodBatchAdminSessionForCalendar | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.id.Id | calendarId | the  Id  of the  Calendar   | 
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.calendaring.batch.TimePeriodBatchAdminSession | a  TimePeriodBatchAdminSession   | |
| Errors | NOT_FOUND | no  Calendar  found by the given  Id   |                 |
| NULL_ARGUMENT |  calendarId  or  proxy  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   | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy | 
| Return | osid.calendaring.batch.CalendarBatchAdminSession | a  CalendarBatchAdminSession   | |
| Errors | NULL_ARGUMENT |  proxy  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsCalendarBatchAdmin()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsCalendarBatchAdmin() 
 is  true.   | |