OSID Logo
OSID Specifications
configuration batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.configuration.batch.ParameterBatchAdminSession
Implementsosid.configuration.ParameterAdminSession
Description

This session creates, updates, and deletes Parameters 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 a Parameter, a ParameterForm is requested using getParameterFormsForCreate() specifying the desired record Types or none if no record Types are needed. Each of the returned ParameterForms 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 a ParameterForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each ParameterForm corresponds to an attempted transaction.

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

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

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

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

The delete operations delete Parameters in bulk. To unmap a Parameter from the current Configuration, the ParameterConfigurationAssignmentSession should be used. These delete operations attempt to remove the Parameter itself thus removing it from all known Configuration catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetParameterFormsForCreate
Description

Gets the parameter forms for creating a bunch of new parameters.

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

Creates a new set of Parameters. 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.ParameterBatchFormListparameterFormsthe parameter forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT parameterForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetParameterFormsForUpdate
Description

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

Parametersosid.id.IdListparameterIdsthe Ids of the Parameter
Returnosid.configuration.batch.ParameterBatchFormListthe parameter form
ErrorsNOT_FOUNDa parameterId is not found
NULL_ARGUMENT parameterIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateParameters
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 BatchCreateResponse .

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

Deletes all Parameters in this Configuration .

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

Deletes parameters for the given Ids.

Parametersosid.id.IdListparameterIdsthe Ids of the parameters to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT parameterIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasParameters
Description

Adds an Id to a Parameter for the purpose of creating compatibility. The primary Id of the Parameter is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another parameter, it is reassigned to the given parameter 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.