OSID Logo
OSID Specifications
assessment batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.assessment.batch.AssessmentBatchAdminSession
Implementsosid.assessment.AssessmentAdminSession
Description

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.

MethodgetAssessmentFormsForCreate
Description

Gets the assessment forms for creating a bunch of new assessments.

Parameterscardinalnumberthe number of forms to retrieve
osid.type.Type[]assessmentRecordTypesarray of assessment record types to be included in each create operation or an empty list if none
Returnosid.assessment.batch.AssessmentBatchFormListthe assessment forms
ErrorsNULL_ARGUMENT assessmentRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateAssessments
Description

Creates a new set of Assessments. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the BatchCreateResponse .

Parametersosid.assessment.batch.AssessmentBatchFormListassessmentFormsthe assessment forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT assessmentForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentFormsForUpdate
Description

Gets the assessment forms for updating an existing set of assessments. A new assessment form should be requested for each update transaction.

Parametersosid.id.IdListassessmentIdsthe Ids of the Assessment
Returnosid.assessment.batch.AssessmentBatchFormListthe assessment form
ErrorsNOT_FOUNDan assessmentId is not found
NULL_ARGUMENT assessmentIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateAssessments
Description

Updates existing assessments. This method returns an error if the entire operation fails. Otherwise, the status of an individual update operation is indicated in the BatchCreateResponse .

Parametersosid.assessment.batch.AssessmentBatchFormListassessmentFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT assessmentForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllAssessments
Description

Deletes all Assessments in this Bank .

Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAssessments
Description

Deletes assessments for the given Ids.

Parametersosid.id.IdListassessmentIdsthe Ids of the assessments to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT assessmentIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasAssessments
Description

Adds an 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.

Parametersosid.transaction.batch.AliasRequestListaliasRequeststhe alias requests
Returnosid.transaction.batch.AliasResponseListthe alias responses
ErrorsNULL_ARGUMENT aliasRequests is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.