OSID Logo
OSID Specifications
assessment batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.assessment.batch.AssessmentTakenBatchAdminSession
Implementsosid.assessment.AssessmentTakenAdminSession
Description

This session creates, updates, and deletes AssessmentsTaken 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 AssessmentTaken, an AssessmentTakenForm is requested using getAssessmentTakenFormsForCreate() specifying the desired assessment offered, resource, and record Types or none if no record Types are needed. Each of the returned AssessmentTakenForms 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 AssessmentTakenForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each AssessmentTakenForm corresponds to an attempted transaction.

The AssessmentTakenForms returned from getAssessmentTakenFormsForCreate() may be linked to the originating request through the peer Ids of the AssessmentTakenForm. In the case where there may be duplicates, any AssessmentTakenForm of the same peer Ids may be used for a create operation.

Once a batch of AssessmentTakenForms are submitted for create, a CreateResponse is returned for each AssessmentTakenForm, although the ordering is not defined. Only errors that pertain to the entire create operation are returned from createAssessmentsTaken(), errors specific to an individual AssessmentTakenForm are indicated in the corresponding CreateResponse. CreateResponses may be linked to the originating AssessmentTakenForm through the AssessmentTakenForm Id .

For updates, AssessmentTakenForms are requested to the AssessmentTaken Id that is to be updated using getAssessmentTakenFormsForUpdate() where the reference Id in the AssessmentTakenForm may be used to link the request. Similarly, the AssessmentTakenForm has metadata about the data that can be updated and it can perform validation before submitting the update. The AssessmentTakenForm can only be used once for a successful update and cannot be reused.

Once a batch of AssessmentTakenForms are submitted for update, an UpdateResponse is returned for each AssessmentTakenForm, although the ordering is not defined. Only errors that pertain to the entire update operation are returned from updateAssessmentsTaken(), errors specific to an individual AssessmentTakenForm are indicated in the corresponding UpdateResponse. UpdateResponses may be linked to the originating AssessmentTakenForm through the AssessmentTakenForm Id.

The delete operations delete AssessmentsTaken in bulk. To unmap an AssessmentTaken from the current Bank, the AssessmentTakenBankAssignmentSession should be used. These delete operations attempt to remove the AssessmentTaken itself thus removing it from all known Bank catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetAssessmentTakenFormsForCreate
Description

Gets the assessment taken forms for creating a bunch of new assessments taken. A form is returned for each supplied assessment offered and resource pair.

Parametersosid.assessment.batch.AssessmentTakenPeerListpeersa list of assessment taken peers
osid.type.Type[]assessmentTakenRecordTypesarray ofassessment taken record types to be included in each create operation or an empty list if none
Returnosid.assessment.batch.AssessmentTakenBatchFormListthe assessment taken forms
ErrorsNOT_FOUNDan assessmentOfferedId or resourceId is not found
NULL_ARGUMENT peers or assessmentTakenRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateAssessmentsTaken
Description

Creates a new set of AssessmentsTaken. 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.AssessmentTakenBatchFormListassessmentTakenFormsthe assessment taken forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT assessmentTakenForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentTakenFormsForUpdate
Description

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

Parametersosid.id.IdListassessmentTakenIdsthe Ids of the AssessmentTaken
Returnosid.assessment.batch.AssessmentTakenBatchFormListthe assessment taken forms
ErrorsNOT_FOUNDan assessmentTakenId is not found
NULL_ARGUMENT assessmentTakenIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateAssessmentsTaken
Description

Updates existing assessments taken. 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.AssessmentTakenBatchFormListassessmentTakenFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT assessmentTakenForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllAssessmentsTaken
Description

Deletes all AssessmentsTaken in this Bank .

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

Deletes assessments taken for the given Ids.

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

Deletes assessments taken for the given taker.

Parametersosid.id.IdresourceIdan Id of a resource
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAssessmentsTakenForAssessmentOffered
Description

Deletes assessments taken for the given assessment offered.

Parametersosid.id.IdassessmentOfferedIdan Id of an assessment offered
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT assessmentOfferedId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasAssessmentsTaken
Description

Adds an Id to an AssessmentTaken for the purpose of creating compatibility. The primary Id of the AssessmentTaken is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another assessment taken, it is reassigned to the given assessment taken 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.