Interface | osid.forum.PostSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing post searches. | ||
Method | searchAmongPosts | ||
Description |
Execute this search among the given list of posts. | ||
Parameters | osid.id.IdList | postIds | list of posts |
Errors | NULL_ARGUMENT | postIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderPostResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.forum.PostSearchOrder | postSearchOrder | post search order |
Errors | NULL_ARGUMENT | postSearchOrder is null | |
UNSUPPORTED | postSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPostSearchRecord | ||
Description |
Gets the post search record corresponding to the given
post search record | ||
Parameters | osid.type.Type | postSearchRecordType | a post search record type |
Return | osid.forum.records.PostSearchRecord | the post search record | |
Errors | NULL_ARGUMENT | postSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(postSearchRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |