public interface Search extends OsidSearch
The search interface for governing searches.
Modifier and Type | Method and Description |
---|---|
SearchRecord |
getSearchRecord(Type searchRecordType)
Gets the search record corresponding to the given search record
Type. |
void |
orderResults(SearchOrder searchOrder)
Specify an ordering to the search results.
|
limitResultSet
getRecordTypes, hasRecordType
void orderResults(SearchOrder searchOrder)
searchOrder
- search orderNullArgumentException
- searchOrder
is
null
UnsupportedException
- searchOrder
is
not of this servicemandatory
- This method must be implemented. SearchRecord getSearchRecord(Type searchRecordType) throws OperationFailedException, PermissionDeniedException
Type.
This method is used to retrieve an object implementing
the requested record.searchRecordType
- a search record typeNullArgumentException
- searchRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
hasRecordType(searchRecordType)
is false
mandatory
- This method must be implemented.