OSID Logo
OSID Specifications
configuration batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.configuration.batch.ValueBatchAdminSession
Implementsosid.configuration.ValueAdminSession
Description

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

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

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

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

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

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

MethodgetValueFormsForCreate
Description

Gets the value forms for creating a bunch of new values. A form is returned for each supplied parameter.

Parametersosid.id.IdListparameterIdListthe number of forms to retrieve
osid.type.Type[]valueRecordTypesarray of value record types to be included in each create operation or an empty list if none
Returnosid.configuration.batch.ValueBatchFormListthe value forms
ErrorsNOT_FOUNDa parameter Id is not found
NULL_ARGUMENT parameterIdList or valueRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateValues
Description

Creates a new set of Values. 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.ValueBatchFormListvalueFormsthe value forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT valueForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetValueFormsForUpdate
Description

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

Parametersosid.id.IdListvalueIdsthe Ids of the Value
Returnosid.configuration.batch.ValueBatchFormListthe value form
ErrorsNOT_FOUNDa valueId is not found
NULL_ARGUMENT valueIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateValues
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 BatchCreateResponse .

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

Deletes all Values in this Configuration .

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

Deletes values for the given Ids.

Parametersosid.id.IdListvalueIdsthe Ids of the values to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT valueIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteValuesForParameter
Description

Deletes values for the given parameter.

Parametersosid.id.IdparameterIda parameter Ids
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT parameterId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasValues
Description

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