Interface | osid.topology.NodeSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing node searches. | ||
Method | searchAmongNodes | ||
Description |
Execute this search among the given list of nodes. | ||
Parameters | osid.id.IdList | nodeIds | list of nodes |
Errors | NULL_ARGUMENT | nodeIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderNodeResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.topology.NodeSearchOrder | nodeSearchOrder | node search order |
Errors | NULL_ARGUMENT | nodeSearchOrder is null | |
UNSUPPORTED | nodeSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getNodeSearchRecord | ||
Description |
Gets the node search record corresponding to the given
node search record | ||
Parameters | osid.type.Type | nodeSearchRecordType | a node search record type |
Return | osid.topology.records.NodeSearchRecord | the node search 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. |