Interface PostSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface PostSearch
extends OsidSearch

The search interface for governing post searches.

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongPosts

void searchAmongPosts(IdList postIds)

Execute this search among the given list of posts.

Parameters:

postIds - list of payers

Throws:

NullArgumentException - postIds is null

Compliance:

mandatory - This method must be implemented.

orderPostResults

void orderPostResults(PostSearchOrder postSearchOrder)

Specify an ordering to the search results.

Parameters:

postSearchOrder - payer search order

Throws:

NullArgumentException - postSearchOrder is null

UnsupportedException - postSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getPostSearchRecord

PostSearchRecord getPostSearchRecord(Type postSearchRecordType)
                              throws OperationFailedException

Gets the post search record corresponding to the given post search record Type . This method is used to retrieve an object implementing the requested record.

Parameters:

postSearchRecordType - a payer search record type

Returns:

the post search record

Throws:

NullArgumentException - postSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(postSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.