Interface | osid.topology.NodeSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getNodes | ||
Description |
Gets the node list resulting from a search. | ||
Return | osid.topology.NodeList | the node list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getNodeQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.topology.NodeQueryInspector | the node query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getNodeSearchResultsRecord | ||
Description |
Gets the node search results record corresponding to
the given node search record | ||
Parameters | osid.type.Type | nodeSearchRecordType | a node search record type |
Return | osid.topology.records.NodeSearchResultsRecord | the node search results record | |
Errors | NULL_ARGUMENT | nodeSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(nodeSearchRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |