Interface | osid.configuration.batch.ValueBatchAdminSession | ||
---|---|---|---|
Implements | osid.configuration.ValueAdminSession | ||
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 | getValueFormsForCreate | ||
Description |
Gets the value forms for creating a bunch of new values. A form is returned for each supplied parameter. | ||
Parameters | osid.id.IdList | parameterIdList | the number of forms to retrieve |
osid.type.Type[] | valueRecordTypes | array of value record types to be included in each create operation or an empty list if none | |
Return | osid.configuration.batch.ValueBatchFormList | the value forms | |
Errors | NOT_FOUND | a parameter Id is not found | |
NULL_ARGUMENT | parameterIdList or valueRecordTypes 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 | createValues | ||
Description |
Creates a new set of | ||
Parameters | osid.configuration.batch.ValueBatchFormList | valueForms | the value forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | valueForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getValueFormsForUpdate | ||
Description |
Gets the value forms for updating an existing set of values. A new value form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | valueIds | the Ids of the Value |
Return | osid.configuration.batch.ValueBatchFormList | the value form | |
Errors | NOT_FOUND | a valueId is not found | |
NULL_ARGUMENT | valueIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateValues | ||
Description |
Updates existing values. This method returns an error
if the entire operation fails. Otherwise, the status of an
individual update operation is indicated in the | ||
Parameters | osid.configuration.batch.ValueBatchFormList | valueForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | valueForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllValues | ||
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 | deleteValues | ||
Description |
Deletes values for the given | ||
Parameters | osid.id.IdList | valueIds | the Ids of the values to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | valueIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteValuesForParameter | ||
Description |
Deletes values for the given parameter. | ||
Parameters | osid.id.Id | parameterId | a parameter Ids |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | parameterId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasValues | ||
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. |