org.osid.course.chronicle.batch

Interface CredentialEntryBatchAdminSession

All Superinterfaces:

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

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasCredentialEntries(AliasRequestList aliasRequests) Adds an Id to a CredentialEntry for the purpose of creating compatibility.
CreateResponseList	createCredentialEntries(CredentialEntryBatchFormList credentialEntryForms) Creates a new set of CredentialEntries.
DeleteResponseList	deleteAllCredentialEntries() Deletes all CredentialEntries in this CourseCatalog .
DeleteResponseList	deleteCredentialEntries(IdList credentialEntryIds) Deletes credential entries for the given Ids.
DeleteResponseList	deleteCredentialEntriesForCredential(Id credentialId) Deletes credential entries for the given credential.
DeleteResponseList	deleteCredentialEntriesForStudent(Id resourceId) Deletes credential entries for the given student.
DeleteResponseList	deleteIneffectiveCredentialEntriesByDate(DateTime date) Deletes credential entries expired before the given date.
CredentialEntryBatchFormList	getCredentialEntryFormsForCreate(CredentialEntryPeerList peers, Type[] credentialEntryRecordTypes) Gets the credential entry forms for creating a bunch of new credential entries.
CredentialEntryBatchFormList	getCredentialEntryFormsForUpdate(IdList credentialEntryIds) Gets the credential entryforms for updating an existing set of credential entries.
UpdateResponseList	updateCredentialEntries(CredentialEntryBatchFormList credentialEntryForms) Updates existing credential entries.

Methods inherited from interface org.osid.course.chronicle.CredentialEntryAdminSession

aliasCredentialEntry, canCreateCredentialEntries, canCreateCredentialEntryWithRecordTypes, canDeleteCredentialEntries, canManageCredentialEntryAliases, canUpdateCredentialEntries, createCredentialEntry, deleteCredentialEntry, getCourseCatalog, getCourseCatalogId, getCredentialEntryFormForCreate, getCredentialEntryFormForUpdate, updateCredentialEntry

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

getCredentialEntryFormsForCreate

CredentialEntryBatchFormList getCredentialEntryFormsForCreate(CredentialEntryPeerList peers,
                                                            Type[] credentialEntryRecordTypes)
                                                              throws NotFoundException,
                                                                     OperationFailedException,
                                                                     PermissionDeniedException

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

Parameters:

peers - a list of credential entry peers

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

Returns:

the credential entry forms

Throws:

NotFoundException - credentialId or resourceId is not found

NullArgumentException - peers or c redentialEntryRecordTypes 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.

createCredentialEntries

CreateResponseList createCredentialEntries(CredentialEntryBatchFormList credentialEntryForms)
                                           throws OperationFailedException,
                                                  PermissionDeniedException

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 .

Parameters:

credentialEntryForms - the credential entry forms

Returns:

the create responses

Throws:

NullArgumentException - credentialEntryForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCredentialEntryFormsForUpdate

CredentialEntryBatchFormList getCredentialEntryFormsForUpdate(IdList credentialEntryIds)
                                                              throws NotFoundException,
                                                                     OperationFailedException,
                                                                     PermissionDeniedException

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

Parameters:

credentialEntryIds - the Ids of the CredentialEntry

Returns:

the credential entry form

Throws:

NotFoundException - a credentialEntryId is not found

NullArgumentException - credentialEntryIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateCredentialEntries

UpdateResponseList updateCredentialEntries(CredentialEntryBatchFormList credentialEntryForms)
                                           throws OperationFailedException,
                                                  PermissionDeniedException

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 .

Parameters:

credentialEntryForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - credentialEntryForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllCredentialEntries

DeleteResponseList deleteAllCredentialEntries()
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Deletes all CredentialEntries in this CourseCatalog .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteCredentialEntries

DeleteResponseList deleteCredentialEntries(IdList credentialEntryIds)
                                           throws OperationFailedException,
                                                  PermissionDeniedException

Deletes credential entries for the given Ids.

Parameters:

credentialEntryIds - the Ids of the credential entries to delete

Returns:

the delete responses

Throws:

NullArgumentException - credentialEntryIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteCredentialEntriesForCredential

DeleteResponseList deleteCredentialEntriesForCredential(Id credentialId)
                                                        throws OperationFailedException,
                                                               PermissionDeniedException

Deletes credential entries for the given credential.

Parameters:

credentialId - the Id of a credential

Returns:

the delete responses

Throws:

NullArgumentException - credentialId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteCredentialEntriesForStudent

DeleteResponseList deleteCredentialEntriesForStudent(Id resourceId)
                                                     throws OperationFailedException,
                                                            PermissionDeniedException

Deletes credential entries for the given student.

Parameters:

resourceId - the Id of a student

Returns:

the delete responses

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteIneffectiveCredentialEntriesByDate

DeleteResponseList deleteIneffectiveCredentialEntriesByDate(DateTime date)
                                                            throws OperationFailedException,
                                                                   PermissionDeniedException

Deletes credential entries expired before the given date.

Parameters:

date - a date

Returns:

the delete responses

Throws:

NullArgumentException - date is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasCredentialEntries

AliasResponseList aliasCredentialEntries(AliasRequestList aliasRequests)
                                         throws OperationFailedException,
                                                PermissionDeniedException

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.

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.