Interface | osid.calendaring.batch.ScheduleBatchAdminSession | ||
---|---|---|---|
Implements | osid.calendaring.ScheduleAdminSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a The Once a batch of For updates, Once a batch of The delete operations delete | ||
Method | getScheduleFormsForCreate | ||
Description |
Gets the schedule forms for creating a bunch of new schedules. A form is returned for each supplied schedule slot and time period pair. | ||
Parameters | osid.calendaring.batch.SchedulePeerList | peers | the schedule peers |
osid.type.Type[] | scheduleRecordTypes | array of schedule record types to be included in each create operation or an empty list if none | |
Return | osid.calendaring.batch.ScheduleBatchFormList | the schedule forms | |
Errors | NOT_FOUND | a scheduleSlotId or timePeriodId is not found | |
NULL_ARGUMENT | peers or scheduleRecordTypes is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to request forms with given record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createSchedules | ||
Description |
Creates a new set of | ||
Parameters | osid.calendaring.batch.ScheduleBatchFormList | scheduleForms | the schedule forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | scheduleForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getScheduleFormsForUpdate | ||
Description |
Gets the schedule forms for updating an existing set of schedules. A new schedule form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | scheduleIds | the Ids of the Schedule |
Return | osid.calendaring.batch.ScheduleBatchFormList | the schedule form | |
Errors | NOT_FOUND | a scheduleId is not found | |
NULL_ARGUMENT | scheduleIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateSchedules | ||
Description |
Updates existing schedules. This method returns an
error if the entire operation fails. Otherwise, the status
of an individual update operation is indicated in the
| ||
Parameters | osid.calendaring.batch.ScheduleBatchFormList | scheduleForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | scheduleForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllSchedules | ||
Description |
Deletes all | ||
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteSchedules | ||
Description |
Deletes schedules for the given | ||
Parameters | osid.id.IdList | scheduleIds | the Ids of the schedules to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | scheduleIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteSchedulesForScheduleSlot | ||
Description |
Deletes schedules for the given schedule slot. | ||
Parameters | osid.id.Id | scheduleSlotId | an Id of a schedule slot |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | scheduleSlotId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteSchedulesForTimePeriod | ||
Description |
Deletes schedules for the given time period. | ||
Parameters | osid.id.Id | timePeriodId | an Id of a time period |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | timePeriodId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasSchedules | ||
Description |
Adds an | ||
Parameters | osid.transaction.batch.AliasRequestList | aliasRequests | the alias requests |
Return | osid.transaction.batch.AliasResponseList | the alias responses | |
Errors | NULL_ARGUMENT | aliasRequests is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |