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.
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.
|
aliasQualifier, canCreateQualifiers, canCreateQualifierWithRecordTypes, canDeleteQualifiers, canManageQualifierAliases, canUpdateQualifiers, createQualifier, deleteQualifier, getQualifierFormForCreate, getQualifierFormForUpdate, getVault, getVaultId, updateQualifier
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
QualifierBatchFormList getQualifierFormsForCreate(long number, Type[] qualifierRecordTypes) throws OperationFailedException, PermissionDeniedException
Id.
number
- the number of forms to retrievequalifierRecordTypes
- array of qualifier record types to be
included in each create operation or an empty list if noneNullArgumentException
- qualifierRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createQualifiers(QualifierBatchFormList qualifierForms) throws OperationFailedException, PermissionDeniedException
Qualifiers.
This method returns an
error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.qualifierForms
- the qualifier formsNullArgumentException
- qualifierForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. QualifierBatchFormList getQualifierFormsForUpdate(IdList qualifierIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
qualifierIds
- the Ids
of the Qualifier
NotFoundException
- a qualifierId
is not
foundNullArgumentException
- qualifierIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateQualifiers(QualifierBatchFormList qualifierForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.qualifierForms
- the form containing the elements to be updatedNullArgumentException
- qualifierForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllQualifiers() throws OperationFailedException, PermissionDeniedException
Qualifiers
in this Vault
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteQualifiers(IdList qualifierIds) throws OperationFailedException, PermissionDeniedException
Ids.
qualifierIds
- the Ids
of the qualifiers to
deleteNullArgumentException
- qualifierIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasQualifiers(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
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.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.