OSID Specifications
topology package
Version 3.0.0
Release Candidate Preview
topology package
Version 3.0.0
Release Candidate Preview
| Interface | osid.topology.GraphSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing graph searches. | ||
| Method | searchAmongGraphs | ||
| Description |
Execute this search among the given list of graphs. | ||
| Parameters | osid.id.IdList | graphIds | list of graphs |
| Errors | NULL_ARGUMENT | graphIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderGraphResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.topology.GraphSearchOrder | graphSearchOrder | graph search order |
| Errors | NULL_ARGUMENT | graphSearchOrder is null | |
| UNSUPPORTED | graphSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getGraphSearchRecord | ||
| Description |
Gets the graph search record corresponding to the given
graph search record | ||
| Parameters | osid.type.Type | graphSearchRecordType | a graph search record type |
| Return | osid.topology.records.GraphSearchRecord | the graph search 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. | |