OSID Logo
OSID Specifications
offering batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.offering.batch.ResultBatchAdminSession
Implementsosid.offering.ResultAdminSession
Description

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.

MethodgetResultFormsForCreate
Description

Gets the result forms for creating a bunch of new results. A form is returned for each participant.

Parametersosid.id.IdListparticipantIdsa list of participants
osid.type.Type[]resultRecordTypesarray of result record types to be included in each create operation or an empty list if none
Returnosid.offering.batch.ResultBatchFormListthe result forms
ErrorsNOT_FOUNDa participantId is not found
NULL_ARGUMENT participantIds or resultRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateResults
Description

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

Parametersosid.offering.batch.ResultBatchFormListresultFormsthe result forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT resultForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetResultFormsForUpdate
Description

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

Parametersosid.id.IdListresultIdsthe Ids of the Result
Returnosid.offering.batch.ResultBatchFormListthe result form
ErrorsNOT_FOUNDa resultId is not found
NULL_ARGUMENT resultIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateResults
Description

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

Parametersosid.offering.batch.ResultBatchFormListresultFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT resultForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllResults
Description

Deletes all Results in this Catalogue .

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

Deletes results for the given Ids.

Parametersosid.id.IdListresultIdsthe Ids of the results to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT resultIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteResultsForParticipant
Description

Deletes results for the given participant.

Parametersosid.id.IdparticipantIdan Id of a participant
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT participantId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasResults
Description

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

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.