OSID Logo
OSID Specifications
authorization batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authorization.batch.QualifierBatchAdminSession
Implementsosid.authorization.QualifierAdminSession
Description

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

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

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

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

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

The delete operations delete Qualifiers in bulk. To unmap a Qualifier from the current Vault, the QualifierVaultAssignmentSession should be used. These delete operations attempt to remove the Qualifier itself thus removing it from all known Vault catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetQualifierFormsForCreate
Description

Gets the qualifier forms for creating a bunch of new qualifiers. A QualifierForm is returned for each competency Id.

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

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

Parametersosid.authorization.batch.QualifierBatchFormListqualifierFormsthe qualifier forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT qualifierForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetQualifierFormsForUpdate
Description

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

Parametersosid.id.IdListqualifierIdsthe Ids of the Qualifier
Returnosid.authorization.batch.QualifierBatchFormListthe qualifier form
ErrorsNOT_FOUNDa qualifierId is not found
NULL_ARGUMENT qualifierIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateQualifiers
Description

Updates existing qualifiers. This method returns an error if the entire operation fails. Otherwise, the status of an individual update operation is indicated in the BatchCreateResponse .

Parametersosid.authorization.batch.QualifierBatchFormListqualifierFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT qualifierForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllQualifiers
Description

Deletes all Qualifiers in this Vault .

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

Deletes qualifiers for the given Ids.

Parametersosid.id.IdListqualifierIdsthe Ids of the qualifiers to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT qualifierIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasQualifiers
Description

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