OSID Specifications
acknowledgement package
Version 3.0.0
Release Candidate Preview
acknowledgement package
Version 3.0.0
Release Candidate Preview
| Interface | osid.acknowledgement.CreditSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getCredits | ||
| Description |
Gets the credit list resulting from a search. | ||
| Return | osid.acknowledgement.CreditList | the credit list | |
| Errors | ILLEGAL_STATE | the list has already been retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCreditQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.acknowledgement.CreditQueryInspector | the query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCreditSearchResultsRecord | ||
| Description |
Gets the record corresponding to the given credit
search record | ||
| Parameters | osid.type.Type | creditSearchRecordType | a credit search record type |
| Return | osid.acknowledgement.records.CreditSearchResultsRecord | the credit search results record | |
| Errors | NULL_ARGUMENT | creditSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(creditSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |