public interface PostSearch extends OsidSearch
The search interface for governing post searches.
Modifier and Type | Method and Description |
---|---|
PostSearchRecord |
getPostSearchRecord(Type postSearchRecordType)
Gets the post search record corresponding to the given post search
record
Type. |
void |
orderPostResults(PostSearchOrder postSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongPosts(IdList postIds)
Execute this search among the given list of posts.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongPosts(IdList postIds)
postIds
- list of postsNullArgumentException
- postIds
is
null
mandatory
- This method must be implemented. void orderPostResults(PostSearchOrder postSearchOrder)
postSearchOrder
- post search orderNullArgumentException
- postSearchOrder
is null
UnsupportedException
- postSearchOrder
is not of this servicemandatory
- This method must be implemented. PostSearchRecord getPostSearchRecord(Type postSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an object
implementing the requested record.postSearchRecordType
- a post search record typeNullArgumentException
- postSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(postSearchRecordType)
is false
mandatory
- This method must be implemented.