Interface | osid.topology.GraphQuery | ||
---|---|---|---|
Implements | osid.OsidCatalogQuery | ||
Description |
This is the query for searching graphs. Each method match
specifies an | ||
Method | matchNodeId | ||
Description |
Sets the node | ||
Parameters | osid.id.Id | nodeId | a node Id |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | nodeId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearNodeIdTerms | ||
Description |
Clears the node | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsNodeQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a node query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getNodeQuery | ||
Description |
Gets the query for a node. Multiple retrievals produce
a nested | ||
Return | osid.topology.NodeQuery | the node query | |
Errors | UNIMPLEMENTED | supportsNodeQuery() is false | |
Compliance | optional | This method must be implemented if supportsNodeQuery() is
true. | |
Method | matchAnyNode | ||
Description |
Matches graphs that have any node. | ||
Parameters | boolean | match | true to match graphs with any node, false to
match graphs with no node |
Compliance | mandatory | This method must be implemented. | |
Method | clearNodeTerms | ||
Description |
Clears the node terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchEdgeId | ||
Description |
Sets the edge | ||
Parameters | osid.id.Id | edgeId | the edge Id |
boolean | match | true for 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 an | ||
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 | matchAnyEdge | ||
Description |
Matches graphs that have any edge. | ||
Parameters | boolean | match | true to match graphs with any edge, false to
match graphs with no edge |
Compliance | mandatory | This method must be implemented. | |
Method | clearEdgeTerms | ||
Description |
Clears the edge terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAncestorGraphId | ||
Description |
Sets the graph | ||
Parameters | osid.id.Id | graphId | a 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 | clearAncestorGraphIdTerms | ||
Description |
Clears the ancestor graph | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsAncestorGraphQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a graph query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAncestorGraphQuery | ||
Description |
Gets the query for a graph. Multiple retrievals produce
a nested | ||
Return | osid.topology.GraphQuery | the graph query | |
Errors | UNIMPLEMENTED | supportsAncestorGraphQuery() is false | |
Compliance | optional | This method must be implemented if supportsAncestorGraphQuery()
is true. | |
Method | matchAnyAncestorGraph | ||
Description |
Matches graphs with any ancestor. | ||
Parameters | boolean | match | true to match graphs with any ancestor, false
to match root graphs |
Compliance | mandatory | This method must be implemented. | |
Method | clearAncestorGraphTerms | ||
Description |
Clears the ancestor graph terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchDescendantGraphId | ||
Description |
Sets the graph | ||
Parameters | osid.id.Id | graphId | a 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 | clearDescendantGraphIdTerms | ||
Description |
Clears the descendant graph | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsDescendantGraphQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a graph query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getDescendantGraphQuery | ||
Description |
Gets the query for a graph. Multiple retrievals produce
a nested | ||
Return | osid.topology.GraphQuery | the graph query | |
Errors | UNIMPLEMENTED | supportsDescendantGraphQuery() is false | |
Compliance | optional | This method must be implemented if supportsDescendantGraphQuery()
is true. | |
Method | matchAnyDescendantGraph | ||
Description |
Matches graphs with any descendant. | ||
Parameters | boolean | match | true to match graphs with any descendant, false
to match leaf graphs |
Compliance | mandatory | This method must be implemented. | |
Method | clearDescendantGraphTerms | ||
Description |
Clears the descendant graph terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getGraphQueryRecord | ||
Description |
Gets the graph query record corresponding to the given
| ||
Parameters | osid.type.Type | graphRecordType | a graph record type |
Return | osid.topology.records.GraphQueryRecord | the graph query record | |
Errors | NULL_ARGUMENT | graphRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(graphRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |