Interface | osid.topology.EdgeSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getEdges | ||
Description |
Gets the edge list resulting from a search. | ||
Return | osid.topology.EdgeList | the edge list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getEdgeQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.topology.EdgeQueryInspector | the edge query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getEdgeSearchResultsRecord | ||
Description |
Gets the edge search results record corresponding to
the given edge search record | ||
Parameters | osid.type.Type | edgeSearchRecordType | a edge search record type |
Return | osid.topology.records.EdgeSearchResultsRecord | the edge search results record | |
Errors | NULL_ARGUMENT | edgeSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(edgeSearchRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |