Interface | osid.course.chronicle.batch.CredentialEntryBatchAdminSession | ||
---|---|---|---|
Implements | osid.course.chronicle.CredentialEntryAdminSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a The Once a batch of For updates, Once a batch of The delete operations delete | ||
Method | getCredentialEntryFormsForCreate | ||
Description |
Gets the credential entry forms for creating a bunch of new credential entries. A form is returned for each credential and student pair. | ||
Parameters | osid.course.chronicle.batch.CredentialEntryPeerList | peers | a list of credential entry peers |
osid.type.Type[] | credentialEntryRecordTypes | array of credential entryrecord types to be included in each create operation or an empty list if none | |
Return | osid.course.chronicle.batch.CredentialEntryBatchFormList | the credential entry forms | |
Errors | NOT_FOUND | credentialId or resourceId is not found | |
NULL_ARGUMENT | peers or c redentialEntryRecordTypes is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to request forms with given record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createCredentialEntries | ||
Description |
Creates a new set of | ||
Parameters | osid.course.chronicle.batch.CredentialEntryBatchFormList | credentialEntryForms | the credential entry forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | credentialEntryForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCredentialEntryFormsForUpdate | ||
Description |
Gets the credential entryforms for updating an existing set of credential entries. A new credential entryform should be requested for each update transaction. | ||
Parameters | osid.id.IdList | credentialEntryIds | the Ids of the CredentialEntry |
Return | osid.course.chronicle.batch.CredentialEntryBatchFormList | the credential entry form | |
Errors | NOT_FOUND | a credentialEntryId is not found | |
NULL_ARGUMENT | credentialEntryIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateCredentialEntries | ||
Description |
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 | ||
Parameters | osid.course.chronicle.batch.CredentialEntryBatchFormList | credentialEntryForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | credentialEntryForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllCredentialEntries | ||
Description |
Deletes all | ||
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteCredentialEntries | ||
Description |
Deletes credential entries for the given | ||
Parameters | osid.id.IdList | credentialEntryIds | the Ids of the credential entries to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | credentialEntryIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteCredentialEntriesForCredential | ||
Description |
Deletes credential entries for the given credential. | ||
Parameters | osid.id.Id | credentialId | the Id of a credential |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | credentialId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteCredentialEntriesForStudent | ||
Description |
Deletes credential entries for the given student. | ||
Parameters | osid.id.Id | resourceId | the Id of a student |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteIneffectiveCredentialEntriesByDate | ||
Description |
Deletes credential entries expired before the given date. | ||
Parameters | osid.calendaring.DateTime | date | a date |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | date is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasCredentialEntries | ||
Description |
Adds an | ||
Parameters | osid.transaction.batch.AliasRequestList | aliasRequests | the alias requests |
Return | osid.transaction.batch.AliasResponseList | the alias responses | |
Errors | NULL_ARGUMENT | aliasRequests is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |