public interface ResultBatchAdminSession extends ResultAdminSession
This session creates, updates, and deletes Results
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
Result,
a ResultForm
is requested using
getResultFormsForCreate()
specifying the desired participant, and
record Types
or none if no record Types
are
needed. Each of the returned ResultForms
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 ResultForm
is submiited to a create operation, it cannot be reused with
another create operation unless the first operation was unsuccessful. Each
ResultForm
corresponds to an attempted transaction.
The ResultForms
returned from
getResultFormsForCreate()
may be linked to the originating request
through the peer Ids
of the ResultForm.
In
the case where there may be duplicates, any ResultForm
of
the same peer Ids
may be used for a create operation.
Once a batch of ResultForms
are submitted for create, a
CreateResponse
is returned for each ResultForm,
although the ordering is not defined. Only errors that pertain to
the entire create operation are returned from createResults(),
errors specific to an individual ResultForm
are
indicated in the corresponding CreateResponse.
CreateResponses
may be linked to the originating ResultForm
through the ResultForm
Id
.
For updates, ResultForms
are requested to the
Result
Id
that is to be updated using
getResultFormsForUpdate()
where the reference Id
in
the ResultForm
may be used to link the request. Similarly,
the ResultForm
has metadata about the data that can be
updated and it can perform validation before submitting the update. The
ResultForm
can only be used once for a successful update
and cannot be reused.
Once a batch of ResultForms
are submitted for update,
an UpdateResponse
is returned for each ResultForm,
although the ordering is not defined. Only errors that pertain to
the entire update operation are returned from updateResults(),
errors specific to an individual ResultForm
are
indicated in the corresponding UpdateResponse.
UpdateResponses
may be linked to the originating ResultForm
through the ResultForm
Id.
The delete operations delete Results
in bulk. To unmap
a Result
from the current Catalogue,
the
ResultCatalogueAssignmentSession
should be used. These
delete operations attempt to remove the Result
itself thus
removing it from all known Catalogue
catalogs. Bulk delete
operations return the results in DeleteResponses.
Modifier and Type | Method and Description |
---|---|
AliasResponseList |
aliasResults(AliasRequestList aliasRequests)
Adds an
Id to a Result for the purpose
of creating compatibility. |
CreateResponseList |
createResults(ResultBatchFormList resultForms)
Creates a new set of
Results. |
DeleteResponseList |
deleteAllResults()
Deletes all
Results in this Catalogue . |
DeleteResponseList |
deleteResults(IdList resultIds)
Deletes results for the given
Ids. |
DeleteResponseList |
deleteResultsForParticipant(Id participantId)
Deletes results for the given participant.
|
ResultBatchFormList |
getResultFormsForCreate(IdList participantIds,
Type[] resultRecordTypes)
Gets the result forms for creating a bunch of new results.
|
ResultBatchFormList |
getResultFormsForUpdate(IdList resultIds)
Gets the result forms for updating an existing set of results.
|
UpdateResponseList |
updateResults(ResultBatchFormList resultForms)
Updates existing results.
|
aliasResult, canCreateResults, canCreateResultWithRecordTypes, canDeleteResults, canManageResultAliases, canUpdateResults, createResult, deleteResult, getCatalogue, getCatalogueId, getResultFormForCreate, getResultFormForUpdate, updateResult
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ResultBatchFormList getResultFormsForCreate(IdList participantIds, Type[] resultRecordTypes) throws NotFoundException, OperationFailedException, PermissionDeniedException
participantIds
- a list of participantsresultRecordTypes
- array of result record types to be included
in each create operation or an empty list if noneNotFoundException
- a participantId
is
not foundNullArgumentException
- participantIds
or resultRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createResults(ResultBatchFormList resultForms) throws OperationFailedException, PermissionDeniedException
Results.
This method returns an
error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.resultForms
- the result formsNullArgumentException
- resultForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ResultBatchFormList getResultFormsForUpdate(IdList resultIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
resultIds
- the Ids
of the Result
NotFoundException
- a resultId
is not
foundNullArgumentException
- resultIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateResults(ResultBatchFormList resultForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.resultForms
- the form containing the elements to be updatedNullArgumentException
- resultForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllResults() throws OperationFailedException, PermissionDeniedException
Results
in this Catalogue
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteResults(IdList resultIds) throws OperationFailedException, PermissionDeniedException
Ids.
resultIds
- the Ids
of the results to deleteNullArgumentException
- resultIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteResultsForParticipant(Id participantId) throws OperationFailedException, PermissionDeniedException
participantId
- an Id
of a participantNullArgumentException
- participantId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasResults(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
Id
to a Result
for the purpose
of creating compatibility. The primary Id
of the
Result
is determined by the provider. The new Id
is an alias to the primary Id.
If the alias is
a pointer to another result, it is reassigned to the given result
Id.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.