public interface DirectionSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
DirectionQueryInspector |
getDirectionQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
DirectionList |
getDirections()
Gets the direction list resulting from a search.
|
DirectionSearchResultsRecord |
getDirectionSearchResultsRecord(Type directionSearchRecordType)
Gets the direction search results record corresponding to the given
direction search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
DirectionList getDirections()
IllegalStateException
- list already retrievedmandatory
- This method must be implemented. DirectionQueryInspector getDirectionQueryInspector()
mandatory
- This method must be implemented. DirectionSearchResultsRecord getDirectionSearchResultsRecord(Type directionSearchRecordType) throws OperationFailedException, PermissionDeniedException
Type.
This method is used to
retrieve an object implementing the requested record.directionSearchRecordType
- a direction search record typeNullArgumentException
-
directionSearchRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
hasRecordType(directionSearchRecordType)
is
false
mandatory
- This method must be implemented.