org.osid.dictionary.batch

Interface DictionaryBatchAdminSession

All Superinterfaces:

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

public interface DictionaryBatchAdminSession
extends DictionaryAdminSession

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

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

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

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

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

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

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasDictionaries(AliasRequestList aliasRequests) Adds an Id to an Dictionary for the purpose of creating compatibility.
CreateResponseList	createDictionaries(DictionaryBatchFormList dictionaryForms) Creates a new set of Dictionaries.
DeleteResponseList	deleteAllDictionaries() Deletes all Dictionaries.
DeleteResponseList	deleteDictionaries(IdList dictionaryIds) Deletes dictionaries for the given Ids.
DictionaryBatchFormList	getDictionaryFormsForCreate(long number, Type[] dictionaryRecordTypes) Gets the dictionary forms for creating a bunch of new dictionaries.
DictionaryBatchFormList	getDictionaryFormsForUpdate(IdList dictionaryIds) Gets the dictionary forms for updating an existing set of dictionaries.
UpdateResponseList	updateDictionaries(DictionaryBatchFormList dictionaryForms) Updates existing dictionaries.

Methods inherited from interface org.osid.dictionary.DictionaryAdminSession

aliasDictionary, canCreateDictionaries, canCreateDictionaryWithRecordTypes, canDeleteDictionaries, canManageDictionaryAliases, canUpdateDictionaries, createDictionary, deleteDictionary, getDictionaryFormForCreate, getDictionaryFormForUpdate, updateDictionary

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

getDictionaryFormsForCreate

DictionaryBatchFormList getDictionaryFormsForCreate(long number,
                                                  Type[] dictionaryRecordTypes)
                                                    throws OperationFailedException,
                                                           PermissionDeniedException

Gets the dictionary forms for creating a bunch of new dictionaries.

Parameters:

number - the number of forms to retrieve

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

Returns:

the dictionary forms

Throws:

NullArgumentException - dictionaryRecordTypes 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.

createDictionaries

CreateResponseList createDictionaries(DictionaryBatchFormList dictionaryForms)
                                      throws OperationFailedException,
                                             PermissionDeniedException

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

Parameters:

dictionaryForms - the dictionary forms

Returns:

the create responses

Throws:

NullArgumentException - dictionaryForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getDictionaryFormsForUpdate

DictionaryBatchFormList getDictionaryFormsForUpdate(IdList dictionaryIds)
                                                    throws NotFoundException,
                                                           OperationFailedException,
                                                           PermissionDeniedException

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

Parameters:

dictionaryIds - the Ids of the Dictionary

Returns:

the dictionary form

Throws:

NotFoundException - an dictionaryId is not found

NullArgumentException - dictionaryIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateDictionaries

UpdateResponseList updateDictionaries(DictionaryBatchFormList dictionaryForms)
                                      throws OperationFailedException,
                                             PermissionDeniedException

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

Parameters:

dictionaryForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - dictionaryForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllDictionaries

DeleteResponseList deleteAllDictionaries()
                                         throws OperationFailedException,
                                                PermissionDeniedException

Deletes all Dictionaries.

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteDictionaries

DeleteResponseList deleteDictionaries(IdList dictionaryIds)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Deletes dictionaries for the given Ids.

Parameters:

dictionaryIds - the Ids of the dictionaries to delete

Returns:

the delete responses

Throws:

NullArgumentException - dictionaryIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasDictionaries

AliasResponseList aliasDictionaries(AliasRequestList aliasRequests)
                                    throws OperationFailedException,
                                           PermissionDeniedException

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