OSID Logo
OSID Specifications
learning batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.learning.batch.ObjectiveBatchAdminSession
Implementsosid.learning.ObjectiveAdminSession
Description

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

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

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

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

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

The delete operations delete Availabilities in bulk. To unmap an Objective from the current ObjectiveBank, the ObjectiveObjectiveBankAssignmentSession should be used. These delete operations attempt to remove the Objective itself thus removing it from all known ObjectiveBank catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetObjectiveFormsForCreate
Description

Gets the objective forms for creating a bunch of new objectives.

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

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

Parametersosid.learning.batch.ObjectiveBatchFormListobjectiveFormsthe objective forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT objectiveForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetObjectiveFormsForUpdate
Description

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

Parametersosid.id.IdListobjectiveIdsthe Ids of the Objective
Returnosid.learning.batch.ObjectiveBatchFormListthe objective form
ErrorsNOT_FOUNDan objectiveId is not found
NULL_ARGUMENT objectiveIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateAvailabilities
Description

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

Parametersosid.learning.batch.ObjectiveBatchFormListobjectiveFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT objectiveForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllAvailabilities
Description

Deletes all Availabilities in this ObjectiveBank .

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

Deletes availabilities for the given Ids.

Parametersosid.id.IdListobjectiveIdsthe Ids of the availabilities to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT objectiveIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasAvailabilities
Description

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