| Interface | osid.control.batch.SettingBatchAdminSession | ||
|---|---|---|---|
| Implements | osid.control.SettingAdminSession | ||
| 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 | getSettingFormsForCreate | ||
| Description |
Gets the setting forms for creating a bunch of new settings. A form is retrieved for each controller. | ||
| Parameters | osid.id.IdList | controllerIds | list of controller Ids |
osid.type.Type[] | settingRecordTypes | array of setting record types to be included in each create operation or an empty list if none | |
| Return | osid.control.batch.SettingBatchFormList | the setting forms | |
| Errors | NOT_FOUND | a controllerId is not found | |
| NULL_ARGUMENT | controllerIds or settingRecordTypes 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 | createSettings | ||
| Description |
Creates a new set of | ||
| Parameters | osid.control.batch.SettingBatchFormList | settingForms | the setting forms |
| Return | osid.transaction.batch.CreateResponseList | the create responses | |
| Errors | NULL_ARGUMENT | settingForms is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getSettingFormsForUpdate | ||
| Description |
Gets the setting forms for updating an existing set of settings. A new setting form should be requested for each update transaction. | ||
| Parameters | osid.id.IdList | settingIds | the Ids of the Setting |
| Return | osid.control.batch.SettingBatchFormList | the setting form | |
| Errors | NOT_FOUND | a settingId is not found | |
| NULL_ARGUMENT | settingIds is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | updateSettings | ||
| Description |
Updates existing settings. 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.SettingBatchFormList | settingForms | the form containing the elements to be updated |
| Return | osid.transaction.batch.UpdateResponseList | the update responses | |
| Errors | NULL_ARGUMENT | settingForms is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteAllSettings | ||
| 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 | deleteSettings | ||
| Description |
Deletes settings for the given | ||
| Parameters | osid.id.IdList | settingIds | the Ids of the settings to delete |
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT | settingIds is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteSettingsForController | ||
| Description |
Deletes settings for the given | ||
| Parameters | osid.id.Id | controllerId | a controller Id |
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT | controllerId is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | aliasSettings | ||
| 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. | |