OSID Logo
OSID Specifications
ontology batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ontology.batch.SubjectBatchAdminSession
Implementsosid.ontology.SubjectAdminSession
Description

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

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

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

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

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

The delete operations delete Subjects in bulk. To unmap a Subject from the current Ontology, the SubjectOntologyAssignmentSession should be used. These delete operations attempt to remove the Subject itself thus removing it from all known Ontology catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetSubjectFormsForCreate
Description

Gets the subject forms for creating a bunch of new subjects.

Parameterscardinalnumberthe number of forms to retrieve
osid.type.Type[]subjectRecordTypesarray of subject record types to be included in each create operation or an empty list if none
Returnosid.ontology.batch.SubjectBatchFormListthe subject forms
ErrorsNULL_ARGUMENT subjectRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateSubjects
Description

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

Parametersosid.ontology.batch.SubjectBatchFormListsubjectFormsthe subject forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT subjectForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSubjectFormsForUpdate
Description

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

Parametersosid.id.IdListsubjectIdsthe Ids of the Subject
Returnosid.ontology.batch.SubjectBatchFormListthe subject form
ErrorsNOT_FOUNDa subjectId is not found
NULL_ARGUMENT subjectIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateSubjects
Description

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

Parametersosid.ontology.batch.SubjectBatchFormListsubjectFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT subjectForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllSubjects
Description

Deletes all Subjects in this Ontology .

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

Deletes subjects for the given Ids.

Parametersosid.id.IdListsubjectIdsthe Ids of the subjects to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT subjectIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasSubjects
Description

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