Interface | osid.blogging.BlogSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getBlogs | ||
Description |
Gets the blog list resulting from the search. This is a retrieve-once method. Another list may be created through performing another search. | ||
Return | osid.blogging.BlogList | the blog list | |
Errors | ILLEGAL_STATE | the blog list has already been retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getBlogQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.blogging.BlogQueryInspector | the query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getBlogSearchResultsRecord | ||
Description |
Gets the blog search results record corresponding to
the given blog search record | ||
Parameters | osid.type.Type | blogSearchRecordType | a blog search record type |
Return | osid.blogging.records.BlogSearchResultsRecord | the blog search rsults record | |
Errors | NULL_ARGUMENT | blogSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(blogSearchRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |