OSID Logo
OSID Specifications
learning batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.learning.batch.ObjectiveBankBatchAdminSession
Implementsosid.learning.ObjectiveBankAdminSession
Description

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

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

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

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

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

The delete operations delete ObjectiveBanks in bulk. Bulk delete operations return the results in DeleteResponses.

MethodgetObjectiveBankFormsForCreate
Description

Gets the objective bank forms for creating a bunch of new objective banks.

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

Creates a new set of ObjectiveBanks. 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.ObjectiveBankBatchFormListobjectiveBankFormsthe objective bank forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT objectiveBankForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetObjectiveBankFormsForUpdate
Description

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

Parametersosid.id.IdListobjectiveBankIdsthe Ids of the ObjectiveBank
Returnosid.learning.batch.ObjectiveBankBatchFormListthe objective bank form
ErrorsNOT_FOUNDan objectiveBankId is not found
NULL_ARGUMENT objectiveBankIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateObjectiveBanks
Description

Updates existing objective banks. 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.ObjectiveBankBatchFormListobjectiveBankFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT objectiveBankForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllObjectiveBanks
Description

Deletes all ObjectiveBanks.

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

Deletes objective banks for the given Ids.

Parametersosid.id.IdListobjectiveBankIdsthe Ids of the objective banks to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT objectiveBankIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasObjectiveBanks
Description

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