org.osid.dictionary.batch

Interface EntryBatchAdminSession

All Superinterfaces:

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

public interface EntryBatchAdminSession
extends EntryAdminSession

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

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

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

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

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

EntryDictionaryAssignmentSession should be used. These delete operations attempt to remove the Entry itself thus removing it from all known Dictionary catalogs. Bulk delete operations return the results in DeleteResponses.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasEntries(AliasRequestList aliasRequests) Adds an Id to an Entry for the purpose of creating compatibility.
CreateResponseList	createEntries(EntryBatchFormList entryForms) Creates a new set of Entries.
DeleteResponseList	deleteAllEntries() Deletes all Entries in this Dictionary.
DeleteResponseList	deleteEntries(IdList entryIds) Deletes entries for the given Ids.
DeleteResponseList	deleteEntriesForKey(Type keyType, java.lang.Object key) Deletes entries for the given key
EntryBatchFormList	getEntryFormsForCreate(EntryPeerList peers, Type[] entryRecordTypes) Gets the entry forms for creating a bunch of new entries.
EntryBatchFormList	getEntryFormsForUpdate(IdList entryIds) Gets the entry forms for updating an existing set of entries.
UpdateResponseList	updateEntries(EntryBatchFormList entryForms) Updates existing entries.

Methods inherited from interface org.osid.dictionary.EntryAdminSession

aliasEntry, canCreateEntries, canCreateEntryWithRecordTypes, canDeleteEntries, canManageEntryAliases, canUpdateEntries, createEntry, deleteEntry, getDictionary, getDictionaryId, getEntryFormForCreate, getEntryFormForUpdate, updateEntry

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

getEntryFormsForCreate

EntryBatchFormList getEntryFormsForCreate(EntryPeerList peers,
                                        Type[] entryRecordTypes)
                                          throws NotFoundException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

Gets the entry forms for creating a bunch of new entries. A form is returned for each work and resource pair.

Parameters:

peers - the entry peers

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

Returns:

the entry forms

Throws:

NotFoundException - a workId or resourceId is not found

NullArgumentException - peers or entryRecordTypes 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.

createEntries

CreateResponseList createEntries(EntryBatchFormList entryForms)
                                 throws OperationFailedException,
                                        PermissionDeniedException

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

Parameters:

entryForms - the entry forms

Returns:

the entry responses

Throws:

NullArgumentException - entryForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEntryFormsForUpdate

EntryBatchFormList getEntryFormsForUpdate(IdList entryIds)
                                          throws NotFoundException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

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

Parameters:

entryIds - the Ids of the Entries

Returns:

the entry forms

Throws:

NotFoundException - an entryId is not found

NullArgumentException - entryIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateEntries

UpdateResponseList updateEntries(EntryBatchFormList entryForms)
                                 throws OperationFailedException,
                                        PermissionDeniedException

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

Parameters:

entryForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - entryForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllEntries

DeleteResponseList deleteAllEntries()
                                    throws OperationFailedException,
                                           PermissionDeniedException

Deletes all Entries in this Dictionary.

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteEntries

DeleteResponseList deleteEntries(IdList entryIds)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Deletes entries for the given Ids.

Parameters:

entryIds - the Ids of the entries to delete

Returns:

the delete responses

Throws:

NullArgumentException - entryIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteEntriesForKey

DeleteResponseList deleteEntriesForKey(Type keyType,
                                     java.lang.Object key)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Deletes entries for the given key

Parameters:

keyType - the key type

key - the key

Returns:

the delete responses

Throws:

NullArgumentException - keyType or key is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasEntries

AliasResponseList aliasEntries(AliasRequestList aliasRequests)
                               throws OperationFailedException,
                                      PermissionDeniedException

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