public interface ForumSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
ForumQueryInspector |
getForumQueryInspector()
Gets the inspector for the query to examine the terns used in the
search.
|
ForumList |
getForums()
Gets the forum list resulting from a search.
|
ForumSearchResultsRecord |
getForumSearchResultsRecord(Type forumSearchRecordType)
Gets the forum search results record corresponding to the given forum
search record Type.
|
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
ForumList getForums()
IllegalStateException
- list has already been retrievedmandatory
- This method must be implemented. ForumQueryInspector getForumQueryInspector()
mandatory
- This method must be implemented. ForumSearchResultsRecord getForumSearchResultsRecord(Type forumSearchRecordType) throws OperationFailedException
forumSearchRecordType
- a forum search record typeNullArgumentException
- forumSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(forumSearchRecordType)
is false
mandatory
- This method must be implemented.