| Interface | osid.course.chronicle.CredentialEntrySearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getCredentialEntries | ||
| Description |
Gets the course list resulting from a search. | ||
| Return | osid.course.chronicle.CredentialEntryList | the credential entry list | |
| Errors | ILLEGAL_STATE | the credential entry list has already been retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCredentialEntryQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.course.chronicle.CredentialEntryQueryInspector | the query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCredentialEntrySearchResultsRecord | ||
| Description |
Gets the credential entry search results record
corresponding to the given credential entry search record
| ||
| Parameters | osid.type.Type | credentialEntrySearchRecordType | a credential entry search record type |
| Return | osid.course.chronicle.records.CredentialEntrySearchResultsRecord | the credential entry search results record | |
| Errors | NULL_ARGUMENT | credentialEntrySearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(credentialEntrySearchRecordType) is
false | ||
| Compliance | mandatory | This method must be implemented. | |