Interface | osid.control.batch.ControllerBatchAdminSession | ||
---|---|---|---|
Implements | osid.control.ControllerAdminSession | ||
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 | getControllerFormsForCreate | ||
Description |
Gets the controller forms for creating a bunch of new controllers. | ||
Parameters | cardinal | n | the number of forms to retrieve |
osid.type.Type[] | controllerRecordTypes | array of controller record types to be included in each create operation or an empty list if none | |
Return | osid.control.batch.ControllerBatchFormList | the controller forms | |
Errors | NULL_ARGUMENT | controllerRecordTypes 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 | createControllers | ||
Description |
Creates a new set of | ||
Parameters | osid.control.batch.ControllerBatchFormList | controllerForms | the controller forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | controllerForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getControllerFormsForUpdate | ||
Description |
Gets the controller forms for updating an existing set of controllers. A new controller form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | controllerIds | the Ids of the Controller |
Return | osid.control.batch.ControllerBatchFormList | the controller form | |
Errors | NOT_FOUND | a controllerId is not found | |
NULL_ARGUMENT | controllerIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateControllers | ||
Description |
Updates existing controllers. This method returns an
error if the entire operation fails. Otherwise, the status
of an individual update operation is indicated in the
| ||
Parameters | osid.control.batch.ControllerBatchFormList | controllerForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | controllerForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllControllers | ||
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 | deleteControllers | ||
Description |
Deletes controllers for the given | ||
Parameters | osid.id.IdList | controllerIds | the Ids of the controllers to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | controllerIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasControllers | ||
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. |