| Interface | osid.subscription.SubscriptionSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getSubscriptions | ||
| Description |
Gets the subscription list resulting from a search. | ||
| Return | osid.subscription.SubscriptionList | the subscription list | |
| Errors | ILLEGAL_STATE | list has already been retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSubscriptionQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terns used in the search. | ||
| Return | osid.subscription.SubscriptionQueryInspector | the query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSubscriptionSearchResultsRecord | ||
| Description |
Gets the subscription search results record
corresponding to the given subscription search record
| ||
| Parameters | osid.type.Type | subscriptionSearchRecordType | a subscription search record type |
| Return | osid.subscription.records.SubscriptionSearchResultsRecord | the subscription search results record | |
| Errors | NULL_ARGUMENT | subscriptionSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(subscriptionSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |