org.osid.course.program.batch

Interface CredentialBatchAdminSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, CredentialAdminSession, 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.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasCredentials(AliasRequestList aliasRequests) Adds an Id to a Credential for the purpose of creating compatibility.
CreateResponseList	createCredentials(CredentialBatchFormList credentialForms) Creates a new set of Credentials.
DeleteResponseList	deleteAllCredentials() Deletes all Credentials in this CourseCatalog .
DeleteResponseList	deleteCredentials(IdList credentialIds) Deletes credentials for the given Ids.
CredentialBatchFormList	getCredentialFormsForCreate(long number, Type[] credentialRecordTypes) Gets the credential forms for creating a bunch of new credentials.
CredentialBatchFormList	getCredentialFormsForUpdate(IdList credentialIds) Gets the credential forms for updating an existing set of credentials.
UpdateResponseList	updateCredentials(CredentialBatchFormList credentialForms) Updates existing credentials.

Methods inherited from interface org.osid.course.program.CredentialAdminSession

aliasCredential, canCreateCredentials, canCreateCredentialWithRecordTypes, canDeleteCredentials, canManageCredentialAliases, canUpdateCredentials, createCredential, deleteCredential, getCourseCatalog, getCourseCatalogId, getCredentialFormForCreate, getCredentialFormForUpdate, updateCredential

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getCredentialFormsForCreate

CredentialBatchFormList getCredentialFormsForCreate(long number,
                                                  Type[] credentialRecordTypes)
                                                    throws OperationFailedException,
                                                           PermissionDeniedException

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

Parameters:

number - the number of forms to retrieve

credentialRecordTypes - array of credential record types to be included in each create operation or an empty list if none

Returns:

the credential forms

Throws:

NullArgumentException - credentialRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to request forms with given record types

Compliance:

mandatory - This method must be implemented.

createCredentials

CreateResponseList createCredentials(CredentialBatchFormList credentialForms)
                                     throws OperationFailedException,
                                            PermissionDeniedException

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 .

Parameters:

credentialForms - the credential forms

Returns:

the create responses

Throws:

NullArgumentException - credentialForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCredentialFormsForUpdate

CredentialBatchFormList getCredentialFormsForUpdate(IdList credentialIds)
                                                    throws NotFoundException,
                                                           OperationFailedException,
                                                           PermissionDeniedException

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

Parameters:

credentialIds - the Ids of the Credential

Returns:

the credential form

Throws:

NotFoundException - a credentialId is not found

NullArgumentException - credentialIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateCredentials

UpdateResponseList updateCredentials(CredentialBatchFormList credentialForms)
                                     throws OperationFailedException,
                                            PermissionDeniedException

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 .

Parameters:

credentialForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - credentialForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllCredentials

DeleteResponseList deleteAllCredentials()
                                        throws OperationFailedException,
                                               PermissionDeniedException

Deletes all Credentials in this CourseCatalog .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteCredentials

DeleteResponseList deleteCredentials(IdList credentialIds)
                                     throws OperationFailedException,
                                            PermissionDeniedException

Deletes credentials for the given Ids.

Parameters:

credentialIds - the Ids of the credentials to delete

Returns:

the delete responses

Throws:

NullArgumentException - credentialIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasCredentials

AliasResponseList aliasCredentials(AliasRequestList aliasRequests)
                                   throws OperationFailedException,
                                          PermissionDeniedException

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.

Parameters:

aliasRequests - the alias requests

Returns:

the alias responses

Throws:

NullArgumentException - aliasRequests is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.