Interface CredentialEntryBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, CredentialEntryAdminSession, OsidSession, OsidSession
public interface CredentialEntryBatchAdminSession extends CredentialEntryAdminSession

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 .