OSID Logo
OSID Specifications
learning batch package
Version 3.1.0
Interfaceosid.learning.batch.ObjectiveBatchAdminSession
Implementsosid.learning.ObjectiveAdminSession
Used Byosid.learning.batch.LearningBatchManager
osid.learning.batch.LearningBatchProxyManager
Description

This session creates, updates, and deletes Objectives 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 createObjectives(), 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 updateObjectives(), 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 Objectives 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.

Parameterscardinalnumber the number of forms to retrieve
osid.type.Type[]objectiveRecordTypes array of objective record types to be included in each create operation or an empty list if none
Returnosid.learning.batch.ObjectiveBatchFormList the objective forms
ErrorsNULL_ARGUMENT objectiveRecordTypes is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
UNSUPPORTED unable to request forms with given record types
Compliancemandatory This method must be implemented.
MethodcreateObjectives
Description

Creates a new set of Objectives. 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.ObjectiveBatchFormListobjectiveForms the objective forms
Returnosid.transaction.batch.CreateResponseList the create responses
ErrorsNULL_ARGUMENT objectiveForms is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodgetObjectiveFormsForUpdate
Description

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

Parametersosid.id.IdListobjectiveIds the Ids of the Objective
Returnosid.learning.batch.ObjectiveBatchFormList the objective form
ErrorsNOT_FOUND an objectiveId is not found
NULL_ARGUMENT objectiveIds is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodupdateObjectives
Description

Updates existing objectives. 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.ObjectiveBatchFormListobjectiveForms the form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseList the update responses
ErrorsNULL_ARGUMENT objectiveForms is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethoddeleteAllObjectives
Description

Deletes all Objectives in this ObjectiveBank.

Returnosid.transaction.batch.DeleteResponseList the delete responses
ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethoddeleteObjectives
Description

Deletes objectives for the given Ids.

Parametersosid.id.IdListobjectiveIds the Ids of the objectives to delete
Returnosid.transaction.batch.DeleteResponseList the delete responses
ErrorsNULL_ARGUMENT objectiveIds is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodaliasObjectives
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.AliasRequestListaliasRequests the alias requests
Returnosid.transaction.batch.AliasResponseList the alias responses
ErrorsNULL_ARGUMENT aliasRequests is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.