Interface CredentialBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, CredentialAdminSession, OsidSession, OsidSession
public interface CredentialBatchAdminSession extends CredentialAdminSession

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

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

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

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

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

The delete operations delete Credentials in bulk. To unmap s Credential from the current CourseCatalog , the CredentialCourseCatalogAssignmentSession should be used. These delete operations attempt to remove the Credential itself thus removing it from all known CourseCatalog catalogs. Bulk delete operations return the results in DeleteResponses .