Interface PostEntrySearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface PostEntrySearch
extends OsidSearch

The search interface for governing post entry searches.

Method Summary

Modifier and Type	Method	Description
PostEntrySearchRecord	getPostEntrySearchRecord(Type postEntrySearchRecordType)	Gets the post entry search record corresponding to the given post entry search record Type .This method is used to retrieve an object implementing the requested record.
void	orderPostEntryResults(PostEntrySearchOrder postEntrySearchOrder)	Specify an ordering to the search results.
void	searchAmongPostEntries(IdList postEntryIds)	Execute this search among the given list of post entries.

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

searchAmongPostEntries

void searchAmongPostEntries(IdList postEntryIds)

Execute this search among the given list of post entries.

Parameters:

postEntryIds - list of entries

Throws:

NullArgumentException - postEntryIds is null

Compliance:

mandatory - This method must be implemented.

orderPostEntryResults

void orderPostEntryResults(PostEntrySearchOrder postEntrySearchOrder)

Specify an ordering to the search results.

Parameters:

postEntrySearchOrder - post entry search order

Throws:

NullArgumentException - postEntrySearchOrder is null

UnsupportedException - postEntrySearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getPostEntrySearchRecord

PostEntrySearchRecord getPostEntrySearchRecord(Type postEntrySearchRecordType)
                                        throws OperationFailedException

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

Parameters:

postEntrySearchRecordType - a post entry search record type

Returns:

the post entry search record

Throws:

NullArgumentException - postEntrySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(postEntrySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.