Interface | osid.topology.GraphSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getGraphs | ||
Description |
Gets the graph list resulting from a search. | ||
Return | osid.topology.GraphList | the graph list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getGraphQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.topology.GraphQueryInspector | the graph query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getGraphSearchResultsRecord | ||
Description |
Gets the graph search results record corresponding to
the given graph search record | ||
Parameters | osid.type.Type | graphSearchRecordType | a graph search record type |
Return | osid.topology.records.GraphSearchResultsRecord | the graph search results record | |
Errors | NULL_ARGUMENT | graphSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(graphSearchRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |