Interface | osid.topology.EdgeSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing edge searches. | ||
Method | searchAmongEdges | ||
Description |
Execute this search among the given list of edges. | ||
Parameters | osid.id.IdList | edgeIds | list of edges |
Errors | NULL_ARGUMENT | edgeIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderEdgeResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.topology.EdgeSearchOrder | edgeSearchOrder | edge search order |
Errors | NULL_ARGUMENT | edgeSearchOrder is null | |
UNSUPPORTED | edgeSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEdgeSearchRecord | ||
Description |
Gets the edge search record corresponding to the given
edge search record | ||
Parameters | osid.type.Type | edgeSearchRecordType | a edge search record type |
Return | osid.topology.records.EdgeSearchRecord | the edge search 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. |