Interface | osid.course.program.batch.CredentialBatchAdminSession | ||
---|---|---|---|
Implements | osid.course.program.CredentialAdminSession | ||
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 | getCredentialFormsForCreate | ||
Description |
Gets the credential forms for creating a bunch of new credentials. | ||
Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | credentialRecordTypes | array of credential record types to be included in each create operation or an empty list if none | |
Return | osid.course.program.batch.CredentialBatchFormList | the credential forms | |
Errors | NULL_ARGUMENT | credentialRecordTypes 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 | createCredentials | ||
Description |
Creates a new set of | ||
Parameters | osid.course.program.batch.CredentialBatchFormList | credentialForms | the credential forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | credentialForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCredentialFormsForUpdate | ||
Description |
Gets the credential forms for updating an existing set of credentials. A new credential form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | credentialIds | the Ids of the Credential |
Return | osid.course.program.batch.CredentialBatchFormList | the credential form | |
Errors | NOT_FOUND | a credentialId is not found | |
NULL_ARGUMENT | credentialIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateCredentials | ||
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
| ||
Parameters | osid.course.program.batch.CredentialBatchFormList | credentialForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | credentialForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllCredentials | ||
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 | deleteCredentials | ||
Description |
Deletes credentials for the given | ||
Parameters | osid.id.IdList | credentialIds | the Ids of the credentials to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | credentialIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasCredentials | ||
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. |