org.osid.authorization.batch

Interface QualifierBatchAdminSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession, QualifierAdminSession

public interface QualifierBatchAdminSession
extends QualifierAdminSession

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.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasQualifiers(AliasRequestList aliasRequests) Adds an Id to a Qualifier for the purpose of creating compatibility.
CreateResponseList	createQualifiers(QualifierBatchFormList qualifierForms) Creates a new set of Qualifiers.
DeleteResponseList	deleteAllQualifiers() Deletes all Qualifiers in this Vault .
DeleteResponseList	deleteQualifiers(IdList qualifierIds) Deletes qualifiers for the given Ids.
QualifierBatchFormList	getQualifierFormsForCreate(long number, Type[] qualifierRecordTypes) Gets the qualifier forms for creating a bunch of new qualifiers.
QualifierBatchFormList	getQualifierFormsForUpdate(IdList qualifierIds) Gets the qualifier forms for updating an existing set of qualifiers.
UpdateResponseList	updateQualifiers(QualifierBatchFormList qualifierForms) Updates existing qualifiers.

Methods inherited from interface org.osid.authorization.QualifierAdminSession

aliasQualifier, canCreateQualifiers, canCreateQualifierWithRecordTypes, canDeleteQualifiers, canManageQualifierAliases, canUpdateQualifiers, createQualifier, deleteQualifier, getQualifierFormForCreate, getQualifierFormForUpdate, getVault, getVaultId, updateQualifier

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getQualifierFormsForCreate

QualifierBatchFormList getQualifierFormsForCreate(long number,
                                                Type[] qualifierRecordTypes)
                                                  throws OperationFailedException,
                                                         PermissionDeniedException

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

Parameters:

number - the number of forms to retrieve

qualifierRecordTypes - array of qualifier record types to be included in each create operation or an empty list if none

Returns:

the qualifier forms

Throws:

NullArgumentException - qualifierRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to request forms with given record types

Compliance:

mandatory - This method must be implemented.

createQualifiers

CreateResponseList createQualifiers(QualifierBatchFormList qualifierForms)
                                    throws OperationFailedException,
                                           PermissionDeniedException

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 .

Parameters:

qualifierForms - the qualifier forms

Returns:

the create responses

Throws:

NullArgumentException - qualifierForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getQualifierFormsForUpdate

QualifierBatchFormList getQualifierFormsForUpdate(IdList qualifierIds)
                                                  throws NotFoundException,
                                                         OperationFailedException,
                                                         PermissionDeniedException

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

Parameters:

qualifierIds - the Ids of the Qualifier

Returns:

the qualifier form

Throws:

NotFoundException - a qualifierId is not found

NullArgumentException - qualifierIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateQualifiers

UpdateResponseList updateQualifiers(QualifierBatchFormList qualifierForms)
                                    throws OperationFailedException,
                                           PermissionDeniedException

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 .

Parameters:

qualifierForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - qualifierForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllQualifiers

DeleteResponseList deleteAllQualifiers()
                                       throws OperationFailedException,
                                              PermissionDeniedException

Deletes all Qualifiers in this Vault .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteQualifiers

DeleteResponseList deleteQualifiers(IdList qualifierIds)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Deletes qualifiers for the given Ids.

Parameters:

qualifierIds - the Ids of the qualifiers to delete

Returns:

the delete responses

Throws:

NullArgumentException - qualifierIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasQualifiers

AliasResponseList aliasQualifiers(AliasRequestList aliasRequests)
                                  throws OperationFailedException,
                                         PermissionDeniedException

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.

Parameters:

aliasRequests - the alias requests

Returns:

the alias responses

Throws:

NullArgumentException - aliasRequests is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.