public interface LocationSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
LocationQueryInspector |
getLocationQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
LocationList |
getLocations()
Gets the location list resulting from a search.
|
LocationSearchResultsRecord |
getLocationSearchResultsRecord(Type locationSearchRecordType)
Gets the record corresponding to the given location search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
LocationList getLocations()
IllegalStateException
- list already retrievedmandatory
- This method must be implemented. LocationQueryInspector getLocationQueryInspector()
mandatory
- This method must be implemented. LocationSearchResultsRecord getLocationSearchResultsRecord(Type locationSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an object
implementing the requested record.locationSearchRecordType
- a location search record typeNullArgumentException
- locationSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(locationSearchRecordType)
is
false
mandatory
- This method must be implemented.