Interface AssessmentBatchAdminSession
- All Superinterfaces:
AssessmentAdminSession, AutoCloseable, Closeable, OsidSession, OsidSession
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 .
-
Method Summary
Modifier and TypeMethodDescriptionaliasAssessments(AliasRequestList aliasRequests) Adds anIdto anAssessmentfor the purpose of creating compatibility.createAssessments(AssessmentBatchFormList assessmentForms) Creates a new set ofAssessments.Deletes allAssessmentsin thisBank.deleteAssessments(IdList assessmentIds) Deletes assessments for the givenIds.getAssessmentFormsForCreate(long number, Type[] assessmentRecordTypes) Gets the assessment forms for creating a bunch of new assessments.getAssessmentFormsForUpdate(IdList assessmentIds) Gets the assessment forms for updating an existing set of assessments.updateAssessments(AssessmentBatchFormList assessmentForms) Updates existing assessments.Methods inherited from interface AssessmentAdminSession
aliasAssessment, canCreateAssessments, canCreateAssessmentWithRecordTypes, canDeleteAssessments, canManageAssessmentAliases, canUpdateAssessments, createAssessment, deleteAssessment, getAssessmentFormForCreate, getAssessmentFormForUpdate, getBank, getBankId, updateAssessmentModifier and TypeMethodDescriptionvoidaliasAssessment(Id assessmentId, Id aliasId) Adds anIdto anAssessmentfor the purpose of creating compatibility.booleanTests if this user can createAssessments.booleancanCreateAssessmentWithRecordTypes(Type[] assessmentRecordTypes) Tests if this user can create a singleAssessmentusing the desired record interface types.booleanTests if this user can deleteAssessments.booleanTests if this user can manageIdaliases forAssessments.booleanTests if this user can updateAssessments.createAssessment(AssessmentForm assessmentForm) Creates a newAssessment.voiddeleteAssessment(Id assessmentId) Deletes anAssessment.getAssessmentFormForCreate(Type[] assessmentRecordTypes) Gets the assessment form for creating new assessments.getAssessmentFormForUpdate(Id assessmentId) Gets the assessment form for updating an existing assessment.getBank()Gets theBankassociated with this session.Gets theBankIdassociated with this session.voidupdateAssessment(AssessmentForm assessmentForm) Updates an existing assessment.Methods inherited from interface OsidSession
closeMethods inherited from interface OsidSession
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactionsModifier and TypeMethodDescriptionGets the agent authenticated to this session.Gets theIdof the agent authenticated to this session.Gets the rate of the service clock.getDate()Gets the service date which may be the current date or the effective date in which this session exists.Gets the effective agent in use by this session.Gets theIdof the effective agent in use by this session.Gets theDisplayTextformatTypepreference in effect for this session.Gets the locale indicating the localization preferences in effect for this session.booleanTests if an agent is authenticated to this session.Starts a new transaction for this sesson.booleanTests for the availability of transactions.
-
Method Details
-
getAssessmentFormsForCreate
AssessmentBatchFormList getAssessmentFormsForCreate(long number, Type[] assessmentRecordTypes) throws OperationFailedException, PermissionDeniedException Gets the assessment forms for creating a bunch of new assessments.- Parameters:
number- the number of forms to retrieveassessmentRecordTypes- array of assessment record types to be included in each create operation or an empty list if none- Returns:
- the assessment forms
- Throws:
NullArgumentException-assessmentRecordTypesisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failureUnsupportedException- unable to request forms with given record types- Compliance:
mandatory- This method must be implemented.
-
createAssessments
CreateResponseList createAssessments(AssessmentBatchFormList assessmentForms) throws OperationFailedException, PermissionDeniedException Creates a new set ofAssessments. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in theBatchCreateResponse.- Parameters:
assessmentForms- the assessment forms- Returns:
- the create responses
- Throws:
NullArgumentException-assessmentFormsisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
getAssessmentFormsForUpdate
AssessmentBatchFormList getAssessmentFormsForUpdate(IdList assessmentIds) throws NotFoundException, OperationFailedException, PermissionDeniedException Gets the assessment forms for updating an existing set of assessments. A new assessment form should be requested for each update transaction.- Parameters:
assessmentIds- theIdsof theAssessment- Returns:
- the assessment form
- Throws:
NotFoundException- anassessmentIdis not foundNullArgumentException-assessmentIdsisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
updateAssessments
UpdateResponseList updateAssessments(AssessmentBatchFormList assessmentForms) throws OperationFailedException, PermissionDeniedException Updates existing assessments. This method returns an error if the entire operation fails. Otherwise, the status of an individual update operation is indicated in theBatchCreateResponse.- Parameters:
assessmentForms- the form containing the elements to be updated- Returns:
- the update responses
- Throws:
NullArgumentException-assessmentFormsisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
deleteAllAssessments
DeleteResponseList deleteAllAssessments() throws OperationFailedException, PermissionDeniedExceptionDeletes allAssessmentsin thisBank.- Returns:
- the delete responses
- Throws:
OperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
deleteAssessments
DeleteResponseList deleteAssessments(IdList assessmentIds) throws OperationFailedException, PermissionDeniedException Deletes assessments for the givenIds.- Parameters:
assessmentIds- theIdsof the assessments to delete- Returns:
- the delete responses
- Throws:
NullArgumentException-assessmentIdsisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
aliasAssessments
AliasResponseList aliasAssessments(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException Adds anIdto anAssessmentfor the purpose of creating compatibility. The primaryIdof theAssessmentis determined by the provider. The newIdis an alias to the primaryId. If the alias is a pointer to another assessment, it is reassigned to the given assessmentId.- Parameters:
aliasRequests- the alias requests- Returns:
- the alias responses
- Throws:
NullArgumentException-aliasRequestsisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-