public interface InquirySearch extends OsidSearch
The search interface for governing inquiry searches.
Modifier and Type | Method and 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.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongInquiries(IdList inquiryIds)
inquiryIds
- list of inquiriesNullArgumentException
- inquiryIds
is
null
mandatory
- This method must be implemented. void orderInquiryResults(InquirySearchOrder inquirySearchOrder)
inquirySearchOrder
- inquiry search orderNullArgumentException
- inquirySearchOrder
is null
UnsupportedException
- inquirySearchOrder
is not of this servicemandatory
- This method must be implemented. InquirySearchRecord getInquirySearchRecord(Type inquirySearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record.inquirySearchRecordType
- an inquiry search record typeNullArgumentException
- inquirySearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(inquirySearchRecordType)
is false
mandatory
- This method must be implemented.