Interface | osid.configuration.batch.ConfigurationBatchAdminSession | ||
---|---|---|---|
Implements | osid.configuration.ConfigurationAdminSession | ||
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 | getConfigurationFormsForCreate | ||
Description |
Gets the configuration forms for creating a bunch of new configurations. | ||
Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | configurationRecordTypes | array of configuration record types to be included in each create operation or an empty list if none | |
Return | osid.configuration.batch.ConfigurationBatchFormList | the configuration forms | |
Errors | NULL_ARGUMENT | configurationRecordTypes 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 | createConfigurations | ||
Description |
Creates a new set of | ||
Parameters | osid.configuration.batch.ConfigurationBatchFormList | configurationForms | the configuration forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | configurationForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getConfigurationFormsForUpdate | ||
Description |
Gets the configuration forms for updating an existing set of configurations. A new configuration form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | configurationIds | the Ids of the Configuration |
Return | osid.configuration.batch.ConfigurationBatchFormList | the configuration form | |
Errors | NOT_FOUND | an configurationId is not found | |
NULL_ARGUMENT | configurationIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateConfigurations | ||
Description |
Updates existing configurations. 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.ConfigurationBatchFormList | configurationForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | configurationForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllConfigurations | ||
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 | deleteConfigurations | ||
Description |
Deletes configurations for the given | ||
Parameters | osid.id.IdList | configurationIds | the Ids of the configurations to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | configurationIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasConfigurations | ||
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. |