Interface | osid.subscription.PublisherSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getPublishers | ||
Description |
Gets the publisher list resulting from a search. | ||
Return | osid.subscription.PublisherList | the publisher list | |
Errors | ILLEGAL_STATE | list has already been retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getPublisherQueryInspector | ||
Description |
Gets the inspector for the query to examine the terns used in the search. | ||
Return | osid.subscription.PublisherQueryInspector | the query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getPublisherSearchResultsRecord | ||
Description |
Gets the publisher search results record corresponding to the given publisher search record Type. This method must be used to retrieve an object implementing the requested record. | ||
Parameters | osid.type.Type | publisherSearchRecordType | a publisher search record type |
Return | osid.subscription.records.PublisherSearchResultsRecord | the publisher search results record | |
Errors | NULL_ARGUMENT | publisherSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(publisherSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |