Interface | osid.calendaring.cycle.batch.CyclicTimePeriodBatchAdminSession | ||
---|---|---|---|
Implements | osid.calendaring.cycle.CyclicTimePeriodAdminSession | ||
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 | getCyclicTimePeriodFormsForCreate | ||
Description |
Gets the cyclic time period forms for creating a bunch of new cyclic time periods. | ||
Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | cyclicTimePeriodRecordTypes | array of cyclic time period record types to be included in each create operation or an empty list if none | |
Return | osid.calendaring.cycle.batch.CyclicTimePeriodBatchFormList | the cyclic time period forms | |
Errors | NULL_ARGUMENT | cyclicTimePeriodRecordTypes 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 | createCyclicTimePeriods | ||
Description |
Creates a new set of | ||
Parameters | osid.calendaring.cycle.batch.CyclicTimePeriodBatchFormList | cyclicTimePeriodForms | the cyclic time period forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | cyclicTimePeriodForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCyclicTimePeriodFormsForUpdate | ||
Description |
Gets the cyclic time period forms for updating an existing set of cyclic time periods. A new cyclic time period form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | cyclicTimePeriodIds | the Ids of the CyclicTimePeriod |
Return | osid.calendaring.cycle.batch.CyclicTimePeriodBatchFormList | the cyclic time period form | |
Errors | NOT_FOUND | a cyclicTimePeriodId is not found | |
NULL_ARGUMENT | cyclicTimePeriodIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateCyclicTimePeriods | ||
Description |
Updates existing cyclic 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.cycle.batch.CyclicTimePeriodBatchFormList | cyclicTimePeriodForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | cyclicTimePeriodForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllCyclicTimePeriods | ||
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 | deleteCyclicTimePeriods | ||
Description |
Deletes cyclic time periods for the given | ||
Parameters | osid.id.IdList | cyclicTimePeriodIds | the Ids of the cyclic time periods to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | cyclicTimePeriodIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasCyclicTimePeriods | ||
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. |