Interface | osid.topology.NodeQuery | ||
---|---|---|---|
Implements | osid.OsidObjectQuery | ||
Description |
This is the query for searching nodes. Each method match
specifies an | ||
Method | matchEdgeId | ||
Description |
Sets the edge | ||
Parameters | osid.id.Id | edgeId | an edge Id |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | edgeId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearEdgeIdTerms | ||
Description |
Clears the edge | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsEdgeQuery | ||
Description |
Tests if a | ||
Return | boolean | true if an edge query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getEdgeQuery | ||
Description |
Gets the query for an edge. Multiple retrievals produce
a nested | ||
Return | osid.topology.EdgeQuery | the edge query | |
Errors | UNIMPLEMENTED | supportsEdgeQuery() is false | |
Compliance | optional | This method must be implemented if supportsEdgeQuery() is
true. | |
Method | clearEdgeTerms | ||
Description |
Clears the edge terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchGraphId | ||
Description |
Sets the graph | ||
Parameters | osid.id.Id | graphId | the graph Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | graphId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearGraphIdTerms | ||
Description |
Clears the graph | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsGraphQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a graph query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getGraphQuery | ||
Description |
Gets the query for a graph. Multiple retrievals produce
a nested | ||
Return | osid.topology.GraphQuery | the graph query | |
Errors | UNIMPLEMENTED | supportsGraphQuery() is false | |
Compliance | optional | This method must be implemented if supportsGraphQuery() is
true. | |
Method | clearGraphTerms | ||
Description |
Clears the graph terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getNodeQueryRecord | ||
Description |
Gets the node record query corresponding to the given
| ||
Parameters | osid.type.Type | nodeRecordType | a node record type |
Return | osid.topology.records.NodeQueryRecord | the node query record | |
Errors | NULL_ARGUMENT | nodeRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(nodeRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |