OSID Logo
OSID Specifications
course chronicle batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.chronicle.batch.CredentialEntryBatchAdminSession
Implementsosid.course.chronicle.CredentialEntryAdminSession
Description

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

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

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

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

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

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

MethodgetCredentialEntryFormsForCreate
Description

Gets the credential entry forms for creating a bunch of new credential entries. A form is returned for each credential and student pair.

Parametersosid.course.chronicle.batch.CredentialEntryPeerListpeersa list of credential entry peers
osid.type.Type[]credentialEntryRecordTypesarray of credential entryrecord types to be included in each create operation or an empty list if none
Returnosid.course.chronicle.batch.CredentialEntryBatchFormListthe credential entry forms
ErrorsNOT_FOUND credentialId or resourceId is not found
NULL_ARGUMENT peers or c redentialEntryRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateCredentialEntries
Description

Creates a new set of CredentialEntries. 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.chronicle.batch.CredentialEntryBatchFormListcredentialEntryFormsthe credential entry forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT credentialEntryForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCredentialEntryFormsForUpdate
Description

Gets the credential entryforms for updating an existing set of credential entries. A new credential entryform should be requested for each update transaction.

Parametersosid.id.IdListcredentialEntryIdsthe Ids of the CredentialEntry
Returnosid.course.chronicle.batch.CredentialEntryBatchFormListthe credential entry form
ErrorsNOT_FOUNDa credentialEntryId is not found
NULL_ARGUMENT credentialEntryIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateCredentialEntries
Description

Updates existing credential entries. 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.chronicle.batch.CredentialEntryBatchFormListcredentialEntryFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT credentialEntryForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllCredentialEntries
Description

Deletes all CredentialEntries in this CourseCatalog .

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

Deletes credential entries for the given Ids.

Parametersosid.id.IdListcredentialEntryIdsthe Ids of the credential entries to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT credentialEntryIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteCredentialEntriesForCredential
Description

Deletes credential entries for the given credential.

Parametersosid.id.IdcredentialIdthe Id of a credential
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT credentialId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteCredentialEntriesForStudent
Description

Deletes credential entries for the given student.

Parametersosid.id.IdresourceIdthe Id of a student
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteIneffectiveCredentialEntriesByDate
Description

Deletes credential entries expired before 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.
MethodaliasCredentialEntries
Description

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