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.
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.
|
aliasCredentialEntry, canCreateCredentialEntries, canCreateCredentialEntryWithRecordTypes, canDeleteCredentialEntries, canManageCredentialEntryAliases, canUpdateCredentialEntries, createCredentialEntry, deleteCredentialEntry, getCourseCatalog, getCourseCatalogId, getCredentialEntryFormForCreate, getCredentialEntryFormForUpdate, updateCredentialEntry
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
CredentialEntryBatchFormList getCredentialEntryFormsForCreate(CredentialEntryPeerList peers, Type[] credentialEntryRecordTypes) throws NotFoundException, OperationFailedException, PermissionDeniedException
peers
- a list of credential entry peerscredentialEntryRecordTypes
- array of credential entryrecord
types to be included in each create operation or an empty list
if noneNotFoundException
- credentialId
or
resourceId
is not foundNullArgumentException
- peers
or c
redentialEntryRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createCredentialEntries(CredentialEntryBatchFormList credentialEntryForms) throws OperationFailedException, PermissionDeniedException
CredentialEntries.
This method
returns an error if the entire operation fails. Otherwise, the status
of an individual create operation is indicated in the
BatchCreateResponse
.credentialEntryForms
- the credential entry formsNullArgumentException
- credentialEntryForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CredentialEntryBatchFormList getCredentialEntryFormsForUpdate(IdList credentialEntryIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
credentialEntryIds
- the Ids
of the
CredentialEntry
NotFoundException
- a credentialEntryId
is not foundNullArgumentException
- credentialEntryIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateCredentialEntries(CredentialEntryBatchFormList credentialEntryForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.credentialEntryForms
- the form containing the elements to be
updatedNullArgumentException
- credentialEntryForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllCredentialEntries() throws OperationFailedException, PermissionDeniedException
CredentialEntries
in this
CourseCatalog
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteCredentialEntries(IdList credentialEntryIds) throws OperationFailedException, PermissionDeniedException
Ids.
credentialEntryIds
- the Ids
of the credential
entries to deleteNullArgumentException
- credentialEntryIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteCredentialEntriesForCredential(Id credentialId) throws OperationFailedException, PermissionDeniedException
credentialId
- the Id
of a credentialNullArgumentException
- credentialId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteCredentialEntriesForStudent(Id resourceId) throws OperationFailedException, PermissionDeniedException
resourceId
- the Id
of a studentNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteIneffectiveCredentialEntriesByDate(DateTime date) throws OperationFailedException, PermissionDeniedException
date
- a dateNullArgumentException
- date
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasCredentialEntries(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
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.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.