Interface | osid.calendaring.batch.TimePeriodBatchAdminSession | ||
---|---|---|---|
Implements | osid.calendaring.TimePeriodAdminSession | ||
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 | getTimePeriodFormsForCreate | ||
Description |
Gets the time period forms for creating a bunch of new time periods. | ||
Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | timePeriodRecordTypes | array of time period record types to be included in each create operation or an empty list if none | |
Return | osid.calendaring.batch.TimePeriodBatchFormList | the time period forms | |
Errors | NULL_ARGUMENT | timePeriodRecordTypes 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 | createTimePeriods | ||
Description |
Creates a new set of | ||
Parameters | osid.calendaring.batch.TimePeriodBatchFormList | timePeriodForms | the time period forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | timePeriodForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getTimePeriodFormsForUpdate | ||
Description |
Gets the time period forms for updating an existing set of time periods. A new time period form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | timePeriodIds | the Ids of the TimePeriod |
Return | osid.calendaring.batch.TimePeriodBatchFormList | the time period form | |
Errors | NOT_FOUND | a timePeriodId is not found | |
NULL_ARGUMENT | timePeriodIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateTimePeriods | ||
Description |
Updates existing time periods. 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.TimePeriodBatchFormList | timePeriodForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | timePeriodForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllTimePeriods | ||
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 | deleteTimePeriods | ||
Description |
Deletes time periods for the given | ||
Parameters | osid.id.IdList | timePeriodIds | the Ids of the time periods to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | timePeriodIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteTimePeriodsByDate | ||
Description |
Deletes time periods containing the given date. | ||
Parameters | osid.calendaring.DateTime | date | a date |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | date is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasTimePeriods | ||
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. |