Interface | osid.configuration.batch.ParameterBatchAdminSession | ||
---|---|---|---|
Implements | osid.configuration.ParameterAdminSession | ||
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 | getParameterFormsForCreate | ||
Description |
Gets the parameter forms for creating a bunch of new parameters. | ||
Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | parameterRecordTypes | array of parameter record types to be included in each create operation or an empty list if none | |
Return | osid.configuration.batch.ParameterBatchFormList | the parameter forms | |
Errors | NULL_ARGUMENT | parameterRecordTypes 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 | createParameters | ||
Description |
Creates a new set of | ||
Parameters | osid.configuration.batch.ParameterBatchFormList | parameterForms | the parameter forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | parameterForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getParameterFormsForUpdate | ||
Description |
Gets the parameter forms for updating an existing set of parameters. A new parameter form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | parameterIds | the Ids of the Parameter |
Return | osid.configuration.batch.ParameterBatchFormList | the parameter form | |
Errors | NOT_FOUND | a parameterId is not found | |
NULL_ARGUMENT | parameterIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateParameters | ||
Description |
Updates existing parameters. 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.ParameterBatchFormList | parameterForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | parameterForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllParameters | ||
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 | deleteParameters | ||
Description |
Deletes parameters for the given | ||
Parameters | osid.id.IdList | parameterIds | the Ids of the parameters to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | parameterIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasParameters | ||
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. |