OSID Logo
OSID Specifications
course batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.batch.CourseCatalogBatchAdminSession
Implementsosid.course.CourseCatalogAdminSession
Description

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

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

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

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

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

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

MethodgetCourseCatalogFormsForCreate
Description

Gets the course catalog forms for creating a bunch of new course catalogs.

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

Creates a new set of CourseCatalogs. 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.CourseCatalogBatchFormListcourseCatalogFormsthe course catalog forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT courseCatalogForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCourseCatalogFormsForUpdate
Description

Gets the course catalog forms for updating an existing set of course catalogs. A new course catalog form should be requested for each update transaction.

Parametersosid.id.IdListcourseCatalogIdsthe Ids of the CourseCatalog
Returnosid.course.batch.CourseCatalogBatchFormListthe course catalog form
ErrorsNOT_FOUNDa courseCatalogId is not found
NULL_ARGUMENT courseCatalogIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateCourseCatalogs
Description

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

Deletes all CourseCatalogs in this Calendar .

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

Deletes course catalogs for the given Ids.

Parametersosid.id.IdListcourseCatalogIdsthe Ids of the course catalogs to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT courseCatalogIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasCourseCatalogs
Description

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