Interface InquiryEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface InquiryEnablerSearch
extends OsidSearch

The search interface for governing inquiry enabler searches.

Method Summary

Modifier and Type	Method	Description
InquiryEnablerSearchRecord	getInquiryEnablerSearchRecord(Type inquiryEnablerSearchRecordType)	Gets the inquiry enabler search record corresponding to the given inquiry enabler search record Type .This method is used to retrieve an object implementing the requested record.
void	orderInquiryEnablerResults(InquiryEnablerSearchOrder inquiryEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongInquiryEnablers(IdList inquiryEnablerIds)	Execute this search among the given list of inquiry enablers.

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

searchAmongInquiryEnablers

void searchAmongInquiryEnablers(IdList inquiryEnablerIds)

Execute this search among the given list of inquiry enablers.

Parameters:

inquiryEnablerIds - list of inquiry enablers

Throws:

NullArgumentException - inquiryEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderInquiryEnablerResults

void orderInquiryEnablerResults(InquiryEnablerSearchOrder inquiryEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

inquiryEnablerSearchOrder - inquiry enabler search order

Throws:

NullArgumentException - inquiryEnablerSearchOrder is null

UnsupportedException - inquiryEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getInquiryEnablerSearchRecord

InquiryEnablerSearchRecord getInquiryEnablerSearchRecord(Type inquiryEnablerSearchRecordType)
                                                  throws OperationFailedException

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

Parameters:

inquiryEnablerSearchRecordType - an inquiry enabler search record type

Returns:

the inquiry enabler search record

Throws:

NullArgumentException - inquiryEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(inquiryEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.