Interface Search
- All Superinterfaces:
Extensible, OsidCondition, OsidSearch, Suppliable
The search interface for governing searches.
-
Method Summary
Modifier and TypeMethodDescriptiongetSearchRecord(Type searchRecordType) Gets the search record corresponding to the given search recordType.voidorderResults(SearchOrder searchOrder) Specify an ordering to the search results.Methods inherited from interface Extensible
getRecordTypes, hasRecordTypeModifier and TypeMethodDescriptionGets the record types available in this object.booleanhasRecordType(Type recordType) Tests if this object supports the given recordType.Methods inherited from interface OsidSearch
limitResultSetModifier and TypeMethodDescriptionvoidlimitResultSet(long start, long end) By default, searches return all matching results.
-
Method Details
-
orderResults
Specify an ordering to the search results.- Parameters:
searchOrder- search order- Throws:
NullArgumentException-searchOrderisnullUnsupportedException-searchOrderis not of this service- Compliance:
mandatory- This method must be implemented.
-
getSearchRecord
SearchRecord getSearchRecord(Type searchRecordType) throws OperationFailedException, PermissionDeniedException Gets the search record corresponding to the given search recordType. This method is used to retrieve an object implementing the requested record.- Parameters:
searchRecordType- a search record type- Returns:
- the search record
- Throws:
NullArgumentException-searchRecordTypeisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure occurredUnsupportedException-hasRecordType(searchRecordType)isfalse- Compliance:
mandatory- This method must be implemented.
-