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.
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.
|
aliasDictionary, canCreateDictionaries, canCreateDictionaryWithRecordTypes, canDeleteDictionaries, canManageDictionaryAliases, canUpdateDictionaries, createDictionary, deleteDictionary, getDictionaryFormForCreate, getDictionaryFormForUpdate, updateDictionary
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
DictionaryBatchFormList getDictionaryFormsForCreate(long number, Type[] dictionaryRecordTypes) throws OperationFailedException, PermissionDeniedException
number
- the number of forms to retrievedictionaryRecordTypes
- array of dictionary record types to be
included in each create operation or an empty list if noneNullArgumentException
- dictionaryRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createDictionaries(DictionaryBatchFormList dictionaryForms) throws OperationFailedException, PermissionDeniedException
Dictionaries.
This method returns
an error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.dictionaryForms
- the dictionary formsNullArgumentException
- dictionaryForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DictionaryBatchFormList getDictionaryFormsForUpdate(IdList dictionaryIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
dictionaryIds
- the Ids
of the Dictionary
NotFoundException
- an dictionaryId
is
not foundNullArgumentException
- dictionaryIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateDictionaries(DictionaryBatchFormList dictionaryForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.dictionaryForms
- the form containing the elements to be updatedNullArgumentException
- dictionaryForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllDictionaries() throws OperationFailedException, PermissionDeniedException
Dictionaries.
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteDictionaries(IdList dictionaryIds) throws OperationFailedException, PermissionDeniedException
Ids.
dictionaryIds
- the Ids
of the dictionaries to
deleteNullArgumentException
- dictionaryIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasDictionaries(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
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.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.