public interface ForumSearch extends OsidSearch
The search interface for governing forum searches.
Modifier and Type | Method and Description |
---|---|
ForumSearchRecord |
getForumSearchRecord(Type forumSearchRecordType)
Gets the forum search record corresponding to the given forum search
record
Type. |
void |
orderForumResults(ForumSearchOrder forumsearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongForums(IdList forumIds)
Execute this search among the given list of forums.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongForums(IdList forumIds)
forumIds
- list of forumsNullArgumentException
- forumIds
is
null
mandatory
- This method must be implemented. void orderForumResults(ForumSearchOrder forumsearchOrder)
forumsearchOrder
- forum search orderNullArgumentException
- forumsearchOrder
is null
UnsupportedException
- forumsearchOrder
is not of this servicemandatory
- This method must be implemented. ForumSearchRecord getForumSearchRecord(Type forumSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an object
implementing the requested record.forumSearchRecordType
- a forum search record typeNullArgumentException
- forumSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(forumSearchRecordType)
is false
mandatory
- This method must be implemented.