Interface | osid.control.batch.InputBatchAdminSession | ||
---|---|---|---|
Implements | osid.control.InputAdminSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create an The Once a batch of For updates, Once a batch of The delete operations delete | ||
Method | getInputFormsForCreate | ||
Description |
Gets the input forms for creating a bunch of new inputs. A form is retrieved for each device and controller pair. | ||
Parameters | osid.control.batch.InputPeerList | peers | list of device controller peers |
osid.type.Type[] | inputRecordTypes | array of input record types to be included in each create operation or an empty list if none | |
Return | osid.control.batch.InputBatchFormList | the input forms | |
Errors | NOT_FOUND | a deviceId or controllerId is not found | |
NULL_ARGUMENT | peers or inputRecordTypes 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 | createInputs | ||
Description |
Creates a new set of | ||
Parameters | osid.control.batch.InputBatchFormList | inputForms | the input forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | inputForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getInputFormsForUpdate | ||
Description |
Gets the input forms for updating an existing set of inputs. A new input form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | inputIds | the Ids of the Input |
Return | osid.control.batch.InputBatchFormList | the input form | |
Errors | NOT_FOUND | an inputId is not found | |
NULL_ARGUMENT | inputIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateInputs | ||
Description |
Updates existing inputs. 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.InputBatchFormList | inputForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | inputForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllInputs | ||
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 | deleteInputs | ||
Description |
Deletes inputs for the given | ||
Parameters | osid.id.IdList | inputIds | the Ids of the inputs to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | inputIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteInputsForDevice | ||
Description |
Deletes inputs for the given | ||
Parameters | osid.id.Id | deviceId | a deviceId Id |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | deviceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteInputsForController | ||
Description |
Deletes inputs 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 | deleteIneffectiveInputsByDate | ||
Description |
Deletes inputs expired before 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 | aliasInputs | ||
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. |