Interface EntrySearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface EntrySearch
extends OsidSearch

This interface specifies options for governing entry searches.

Method Summary

Modifier and Type	Method	Description
EntrySearchRecord	getEntrySearchRecord(Type entrySearchRecordType)	Gets the entry search record corresponding to the given entry search record Type .
void	orderEntryResults(EntrySearchOrder entrySearchOrder)	Specify an ordering to the search results.
void	searchAmongEntries(IdList entryIds)	Execute this search among the given list of 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

searchAmongEntries

void searchAmongEntries(IdList entryIds)

Execute this search among the given list of entries.

Parameters:

entryIds - list of entry Ids

Throws:

NullArgumentException - entryIds is null

Compliance:

mandatory - This method must be implemented.

orderEntryResults

void orderEntryResults(EntrySearchOrder entrySearchOrder)

Specify an ordering to the search results.

Parameters:

entrySearchOrder - entry searcgh order

Throws:

NullArgumentException - entrySearchOrder is null

UnsupportedException - entrySearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getEntrySearchRecord

EntrySearchRecord getEntrySearchRecord(Type entrySearchRecordType)
                                throws OperationFailedException

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

Parameters:

entrySearchRecordType - an entry search record type

Returns:

the entry search record

Throws:

NullArgumentException - entrySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(entrySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.