OSID Logo
OSID Specifications
course batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.batch.TermBatchAdminSession
Implementsosid.course.TermAdminSession
Description

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

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

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

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

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

The delete operations delete Terms in bulk. To unmap a Term from the current CourseCatalog, the TermCourseCatalogAssignmentSession should be used. These delete operations attempt to remove the Term itself thus removing it from all known CourseCatalog catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetTermFormsForCreate
Description

Gets the term forms for creating a bunch of new terms.

Parameterscardinalnumberthe number of forms to retrieve
osid.type.Type[]termRecordTypesarray of term record types to be included in each create operation or an empty list if none
Returnosid.course.batch.TermBatchFormListthe term forms
ErrorsNULL_ARGUMENT termRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateTerms
Description

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

Parametersosid.course.batch.TermBatchFormListtermFormsthe term forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT termForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetTermFormsForUpdate
Description

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

Parametersosid.id.IdListtermIdsthe Ids of the Term
Returnosid.course.batch.TermBatchFormListthe term form
ErrorsNOT_FOUNDa termId is not found
NULL_ARGUMENT termIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateTerms
Description

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

Parametersosid.course.batch.TermBatchFormListtermFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT termForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllTerms
Description

Deletes all Terms in this CourseCatalog .

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

Deletes terms for the given Ids.

Parametersosid.id.IdListtermIdsthe Ids of the terms to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT termIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteChildTerms
Description

Deletes terms under the given term.

Parametersosid.id.IdtermIdan Id of a term
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT termId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteTermsByDate
Description

Deletes terms containing 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.
MethodaliasTerms
Description

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