public interface ValueBatchAdminSession extends ValueAdminSession
This session creates, updates, and deletes Values
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
Value,
a ValueForm
is requested using
getValueFormsForCreate()
specifying the desired parameter and
record Types
or none if no record Types
are
needed. Each of the returned ValueForms
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 ValueForm
is submiited to a create operation, it cannot be reused with
another create operation unless the first operation was unsuccessful. Each
ValueForm
corresponds to an attempted transaction.
The ValueForms
returned from
getValueFormsForCreate()
may be linked to the originating request
through the peer Ids
of the ValueForm.
In
the case where there may be duplicates, any ValueForm
of
the same peer Ids
may be used for a create operation.
Once a batch of ValueForms
are submitted for create, a
CreateResponse
is returned for each ValueForm,
although the ordering is not defined. Only errors that pertain to
the entire create operation are returned from createValues(),
errors specific to an individual ValueForm
are
indicated in the corresponding CreateResponse.
CreateResponses
may be linked to the originating ValueForm
through the ValueForm
Id
.
For updates, ValueForms
are requested to the
Value
Id
that is to be updated using
getValueFormsForUpdate()
where the reference Id
in
the ValueForm
may be used to link the request. Similarly,
the ValueForm
has metadata about the data that can be
updated and it can perform validation before submitting the update. The
ValueForm
can only be used once for a successful update and
cannot be reused.
Once a batch of ValueForms
are submitted for update, an
UpdateResponse
is returned for each ValueForm,
although the ordering is not defined. Only errors that pertain to
the entire update operation are returned from updateValues(),
errors specific to an individual ValueForm
are
indicated in the corresponding UpdateResponse.
UpdateResponses
may be linked to the originating ValueForm
through the ValueForm
Id.
The delete operations delete Values
in bulk. To unmap a
Value
from the current Configuration,
the
ValueConfigurationAssignmentSession
should be used. These
delete operations attempt to remove the Value
itself thus
removing it from all known Configuration
catalogs. Bulk
delete operations return the results in DeleteResponses.
Modifier and Type | Method and Description |
---|---|
AliasResponseList |
aliasValues(AliasRequestList aliasRequests)
Adds an
Id to a Value for the purpose of
creating compatibility. |
CreateResponseList |
createValues(ValueBatchFormList valueForms)
Creates a new set of
Values. |
DeleteResponseList |
deleteAllValues()
Deletes all
Values in this Configuration
. |
DeleteResponseList |
deleteValues(IdList valueIds)
Deletes values for the given
Ids. |
DeleteResponseList |
deleteValuesForParameter(Id parameterId)
Deletes values for the given parameter.
|
ValueBatchFormList |
getValueFormsForCreate(IdList parameterIdList,
Type[] valueRecordTypes)
Gets the value forms for creating a bunch of new values.
|
ValueBatchFormList |
getValueFormsForUpdate(IdList valueIds)
Gets the value forms for updating an existing set of values.
|
UpdateResponseList |
updateValues(ValueBatchFormList valueForms)
Updates existing values.
|
aliasValue, canCreateValues, canCreateValueWithRecordTypes, canDeleteValues, canManageValueAliases, canUpdateValues, createValue, deleteValue, getConfiguration, getConfigurationId, getValueFormForCreate, getValueFormForUpdate, supportValueConditions, updateValue
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ValueBatchFormList getValueFormsForCreate(IdList parameterIdList, Type[] valueRecordTypes) throws NotFoundException, OperationFailedException, PermissionDeniedException
parameterIdList
- the number of forms to retrievevalueRecordTypes
- array of value record types to be included in
each create operation or an empty list if noneNotFoundException
- a parameter Id
is
not foundNullArgumentException
- parameterIdList
or valueRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createValues(ValueBatchFormList valueForms) throws OperationFailedException, PermissionDeniedException
Values.
This method returns an
error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.valueForms
- the value formsNullArgumentException
- valueForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ValueBatchFormList getValueFormsForUpdate(IdList valueIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
valueIds
- the Ids
of the Value
NotFoundException
- a valueId
is not
foundNullArgumentException
- valueIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateValues(ValueBatchFormList valueForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.valueForms
- the form containing the elements to be updatedNullArgumentException
- valueForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllValues() throws OperationFailedException, PermissionDeniedException
Values
in this Configuration
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteValues(IdList valueIds) throws OperationFailedException, PermissionDeniedException
Ids.
valueIds
- the Ids
of the values to deleteNullArgumentException
- valueIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteValuesForParameter(Id parameterId) throws OperationFailedException, PermissionDeniedException
parameterId
- a parameter Ids
NullArgumentException
- parameterId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasValues(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
Id
to a Value
for the purpose of
creating compatibility. The primary Id
of the
Value
is determined by the provider. The new Id
is an alias to the primary Id.
If the alias is a
pointer to another value, it is reassigned to the given value
Id.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.