OSID Logo
OSID Specifications
configuration batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.configuration.batch.ConfigurationBatchAdminSession
Implementsosid.configuration.ConfigurationAdminSession
Description

This session creates, updates, and deletes Configurations in bulk. The data for create and update is provided by the consumer via the form object. OsidForms are requested for each create or update and may not be reused.

Create and update operations differ in their usage. To create an Configuration, an ConfigurationForm is requested using getConfigurationFormsForCreate() specifying the desired record Types or none if no record Types are needed. Each of the returned ConfigurationForms will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once an ConfigurationForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each ConfigurationForm corresponds to an attempted transaction.

The ConfigurationForms returned from getConfigurationFormsForCreate() may be linked to the originating request through the peer Ids of the ConfigurationForm. In the case where there may be duplicates, any ConfigurationForm of the same peer Ids may be used for a create operation.

Once a batch of ConfigurationForms are submitted for create, a CreateResponse is returned for each ConfigurationForm, although the ordering is not defined. Only errors that pertain to the entire create operation are returned from createConfigurations(), errors specific to an individual ConfigurationForm are indicated in the corresponding CreateResponse. CreateResponses may be linked to the originating ConfigurationForm through the ConfigurationForm Id .

For updates, ConfigurationForms are requested to the Configuration Id that is to be updated using getConfigurationFormsForUpdate() where the reference Id in the ConfigurationForm may be used to link the request. Similarly, the ConfigurationForm has metadata about the data that can be updated and it can perform validation before submitting the update. The ConfigurationForm can only be used once for a successful update and cannot be reused.

Once a batch of ConfigurationForms are submitted for update, an UpdateResponse is returned for each ConfigurationForm, although the ordering is not defined. Only errors that pertain to the entire update operation are returned from updateConfigurations(), errors specific to an individual ConfigurationForm are indicated in the corresponding UpdateResponse. UpdateResponses may be linked to the originating ConfigurationForm through the ConfigurationForm Id.

The delete operations delete Configurations in bulk. Bulk delete operations return the results in DeleteResponses.

MethodgetConfigurationFormsForCreate
Description

Gets the configuration forms for creating a bunch of new configurations.

Parameterscardinalnumberthe number of forms to retrieve
osid.type.Type[]configurationRecordTypesarray of configuration record types to be included in each create operation or an empty list if none
Returnosid.configuration.batch.ConfigurationBatchFormListthe configuration forms
ErrorsNULL_ARGUMENT configurationRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateConfigurations
Description

Creates a new set of Configurations. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the BatchCreateResponse .

Parametersosid.configuration.batch.ConfigurationBatchFormListconfigurationFormsthe configuration forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT configurationForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetConfigurationFormsForUpdate
Description

Gets the configuration forms for updating an existing set of configurations. A new configuration form should be requested for each update transaction.

Parametersosid.id.IdListconfigurationIdsthe Ids of the Configuration
Returnosid.configuration.batch.ConfigurationBatchFormListthe configuration form
ErrorsNOT_FOUNDan configurationId is not found
NULL_ARGUMENT configurationIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateConfigurations
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 BatchCreateResponse .

Parametersosid.configuration.batch.ConfigurationBatchFormListconfigurationFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT configurationForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllConfigurations
Description

Deletes all Configurations.

Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteConfigurations
Description

Deletes configurations for the given Ids.

Parametersosid.id.IdListconfigurationIdsthe Ids of the configurations to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT configurationIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasConfigurations
Description

Adds an Id to an Configuration for the purpose of creating compatibility. The primary Id of the Configuration is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another configuration, it is reassigned to the given entry Id.

Parametersosid.transaction.batch.AliasRequestListaliasRequeststhe alias requests
Returnosid.transaction.batch.AliasResponseListthe alias responses
ErrorsNULL_ARGUMENT aliasRequests is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.