| Interface | osid.course.program.CredentialSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing credential searches. | ||
| Method | searchAmongCredentials | ||
| Description |
Execute this search among the given list of credentials. | ||
| Parameters | osid.id.IdList | credentialIds | list of credentials |
| Errors | NULL_ARGUMENT | credentialIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderCredentialResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.course.program.CredentialSearchOrder | credentialSearchOrder | credential search order |
| Errors | NULL_ARGUMENT | credentialSearchOrder is null | |
| UNSUPPORTED | credentialSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getCredentialSearchRecord | ||
| Description |
Gets the credential search record corresponding to the
given credential search record | ||
| Parameters | osid.type.Type | credentialSearchRecordType | a credential search record type |
| Return | osid.course.program.records.CredentialSearchRecord | the credential search record | |
| Errors | NULL_ARGUMENT | credentialSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(credentialSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |