OSID Logo
OSID Specifications
learning batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.learning.batch.ProficiencyBatchAdminSession
Implementsosid.learning.ProficiencyAdminSession
Description

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

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

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

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

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

The delete operations delete Proficiencies in bulk. To unmap a Proficiency from the current ObjectiveBank, the ProficiencyObjectiveBankAssignmentSession should be used. These delete operations attempt to remove the Proficiency itself thus removing it from all known ObjectiveBank catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetProficiencyFormsForCreate
Description

Gets the proficiency forms for creating a bunch of new proficiencies. A form is returned for each supplied objective and resource peer.

Parametersosid.learning.batch.ProficiencyPeerListpeersthe proficiency peers
osid.type.Type[]proficiencyRecordTypesarray of proficiency record types to be included in each create operation or an empty list if none
Returnosid.learning.batch.ProficiencyBatchFormListthe proficiency forms
ErrorsNOT_FOUNDan objectiveId or resourceId is not found
NULL_ARGUMENT peers or proficiencyRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateProficiencies
Description

Creates a new set of Proficiencies. 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.ProficiencyBatchFormListproficiencyFormsthe proficiency forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT proficiencyForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProficiencyFormsForUpdate
Description

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

Parametersosid.id.IdListproficiencyIdsthe Ids of the Proficiency
Returnosid.learning.batch.ProficiencyBatchFormListthe proficiency form
ErrorsNOT_FOUNDa proficiencyId is not found
NULL_ARGUMENT proficiencyIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateProficiencies
Description

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

Deletes all Proficiencies in this ObjectiveBank .

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

Deletes proficiencies for the given Ids.

Parametersosid.id.IdListproficiencyIdsthe Ids of the proficiencies to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT proficiencyIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteProficienciesForObjective
Description

Deletes proficiencies for the given objective.

Parametersosid.id.IdobjectiveIdthe Id of an objective
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT objectiveId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteProficienciesForResource
Description

Deletes proficiencies for the given resource.

Parametersosid.id.IdresourceIdthe 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.
MethoddeleteIneffectiveProficienciesByDate
Description

Deletes proficiencies expired befoe the given date.

Parametersosid.calendaring.DateTimedatea date
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT date is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasProficiencies
Description

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