Interface InquirySearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface InquirySearch
extends OsidSearch

The search interface for governing inquiry searches.

Method Summary

Modifier and Type	Method	Description
InquirySearchRecord	getInquirySearchRecord(Type inquirySearchRecordType)	Gets the inquiry search record corresponding to the given inquiry search record Type.
void	orderInquiryResults(InquirySearchOrder inquirySearchOrder)	Specify an ordering to the search results.
void	searchAmongInquiries(IdList inquiryIds)	Execute this search among the given list of inquiries.

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

searchAmongInquiries

void searchAmongInquiries(IdList inquiryIds)

Execute this search among the given list of inquiries.

Parameters:

inquiryIds - list of inquiries

Throws:

NullArgumentException - inquiryIds is null

Compliance:

mandatory - This method must be implemented.

orderInquiryResults

void orderInquiryResults(InquirySearchOrder inquirySearchOrder)

Specify an ordering to the search results.

Parameters:

inquirySearchOrder - inquiry search order

Throws:

NullArgumentException - inquirySearchOrder is null

UnsupportedException - inquirySearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getInquirySearchRecord

InquirySearchRecord getInquirySearchRecord(Type inquirySearchRecordType)
                                    throws OperationFailedException

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

Parameters:

inquirySearchRecordType - an inquiry search record type

Returns:

the inquiry search record

Throws:

NullArgumentException - inquirySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(inquirySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.