Interface | osid.course.program.CredentialSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getCredentials | ||
Description |
Gets the credential list resulting from a search. | ||
Return | osid.course.program.CredentialList | the credential list | |
Errors | ILLEGAL_STATE | the credential list has already been retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getCredentialQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.course.program.CredentialQueryInspector | the credential query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getCredentialSearchResultsRecord | ||
Description |
Gets the credential search results record corresponding
to the given credential search record | ||
Parameters | osid.type.Type | credentialSearchRecordType | a credential search record type |
Return | osid.course.program.records.CredentialSearchResultsRecord | the credential search results 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. |