public interface PositionSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
PositionQueryInspector |
getPositionQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
PositionList |
getPositions()
Gets the position list resulting from a search.
|
PositionSearchResultsRecord |
getPositionSearchResultsRecord(Type positionSearchRecordType)
Gets the record corresponding to the given position search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
PositionList getPositions()
IllegalStateException
- the list has already been
retrievedmandatory
- This method must be implemented. PositionQueryInspector getPositionQueryInspector()
mandatory
- This method must be implemented. PositionSearchResultsRecord getPositionSearchResultsRecord(Type positionSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an object
implementing the requested record.positionSearchRecordType
- a position search record typeNullArgumentException
- positionSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(positionSearchRecordType)
is
false
mandatory
- This method must be implemented.