OSID Logo
OSID Specifications
course program batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.program.batch.CredentialBatchAdminSession
Implementsosid.course.program.CredentialAdminSession
Description

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.

MethodgetCredentialFormsForCreate
Description

Gets the credential forms for creating a bunch of new credentials.

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

Creates a new set of Credentials. 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.program.batch.CredentialBatchFormListcredentialFormsthe credential forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT credentialForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCredentialFormsForUpdate
Description

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

Parametersosid.id.IdListcredentialIdsthe Ids of the Credential
Returnosid.course.program.batch.CredentialBatchFormListthe credential form
ErrorsNOT_FOUNDa credentialId is not found
NULL_ARGUMENT credentialIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateCredentials
Description

Updates existing credentials. 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.program.batch.CredentialBatchFormListcredentialFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT credentialForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllCredentials
Description

Deletes all Credentials in this CourseCatalog .

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

Deletes credentials for the given Ids.

Parametersosid.id.IdListcredentialIdsthe Ids of the credentials to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT credentialIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasCredentials
Description

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