public interface AssessmentBatchAdminSession extends AssessmentAdminSession
This session creates, updates, and deletes Assessments
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
Assessment,
an AssessmentForm
is requested
using getAssessmentFormsForCreate()
specifying the desired
record Types
or none if no record Types
are
needed. Each of the returned AssessmentForms
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 AssessmentForm
is submiited to a create operation, it cannot be reused with
another create operation unless the first operation was unsuccessful. Each
AssessmentForm
corresponds to an attempted transaction.
The AssessmentForms
returned from
getAssessmentFormsForCreate()
may be linked to the originating
request through the peer Ids
of the AssessmentForm.
In the case where there may be duplicates, any
AssessmentForm
of the same peer Ids
may be used for
a create operation.
Once a batch of AssessmentForms
are submitted for
create, a CreateResponse
is returned for each
AssessmentForm,
although the ordering is not defined. Only errors
that pertain to the entire create operation are returned from
createAssessments(),
errors specific to an individual
AssessmentForm
are indicated in the corresponding
CreateResponse.
CreateResponses
may be linked to
the originating AssessmentForm
through the
AssessmentForm
Id
.
For updates, AssessmentForms
are requested to the
Assessment
Id
that is to be updated using
getAssessmentFormsForUpdate()
where the reference Id
in the AssessmentForm
may be used to link the
request. Similarly, the AssessmentForm
has metadata about
the data that can be updated and it can perform validation before
submitting the update. The AssessmentForm
can only be used
once for a successful update and cannot be reused.
Once a batch of AssessmentForms
are submitted for
update, an UpdateResponse
is returned for each
AssessmentForm,
although the ordering is not defined. Only errors
that pertain to the entire update operation are returned from
updateAssessments(),
errors specific to an individual
AssessmentForm
are indicated in the corresponding
UpdateResponse.
UpdateResponses
may be linked to
the originating AssessmentForm
through the
AssessmentForm
Id.
The delete operations delete Assessments
in bulk. To
unmap an Assessment
from the current Bank,
the AssessmentBankAssignmentSession
should be used. These
delete operations attempt to remove the Assessment
itself
thus removing it from all known Bank
catalogs. Bulk delete
operations return the results in DeleteResponses.
Modifier and Type | Method and Description |
---|---|
AliasResponseList |
aliasAssessments(AliasRequestList aliasRequests)
Adds an
Id to an Assessment for the
purpose of creating compatibility. |
CreateResponseList |
createAssessments(AssessmentBatchFormList assessmentForms)
Creates a new set of
Assessments. |
DeleteResponseList |
deleteAllAssessments()
Deletes all
Assessments in this Bank . |
DeleteResponseList |
deleteAssessments(IdList assessmentIds)
Deletes assessments for the given
Ids. |
AssessmentBatchFormList |
getAssessmentFormsForCreate(long number,
Type[] assessmentRecordTypes)
Gets the assessment forms for creating a bunch of new assessments.
|
AssessmentBatchFormList |
getAssessmentFormsForUpdate(IdList assessmentIds)
Gets the assessment forms for updating an existing set of assessments.
|
UpdateResponseList |
updateAssessments(AssessmentBatchFormList assessmentForms)
Updates existing assessments.
|
aliasAssessment, canCreateAssessments, canCreateAssessmentWithRecordTypes, canDeleteAssessments, canManageAssessmentAliases, canUpdateAssessments, createAssessment, deleteAssessment, getAssessmentFormForCreate, getAssessmentFormForUpdate, getBank, getBankId, updateAssessment
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
AssessmentBatchFormList getAssessmentFormsForCreate(long number, Type[] assessmentRecordTypes) throws OperationFailedException, PermissionDeniedException
number
- the number of forms to retrieveassessmentRecordTypes
- array of assessment record types to be
included in each create operation or an empty list if noneNullArgumentException
- assessmentRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createAssessments(AssessmentBatchFormList assessmentForms) throws OperationFailedException, PermissionDeniedException
Assessments.
This method returns
an error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.assessmentForms
- the assessment formsNullArgumentException
- assessmentForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AssessmentBatchFormList getAssessmentFormsForUpdate(IdList assessmentIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
assessmentIds
- the Ids
of the Assessment
NotFoundException
- an assessmentId
is
not foundNullArgumentException
- assessmentIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateAssessments(AssessmentBatchFormList assessmentForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.assessmentForms
- the form containing the elements to be updatedNullArgumentException
- assessmentForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllAssessments() throws OperationFailedException, PermissionDeniedException
Assessments
in this Bank
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAssessments(IdList assessmentIds) throws OperationFailedException, PermissionDeniedException
Ids.
assessmentIds
- the Ids
of the assessments to
deleteNullArgumentException
- assessmentIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasAssessments(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
Id
to an Assessment
for the
purpose of creating compatibility. The primary Id
of
the Assessment
is determined by the provider. The new
Id
is an alias to the primary Id.
If the
alias is a pointer to another assessment, it is reassigned to the
given assessment Id.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.