OSID - osid.topology.NodeQuery Service Interface Definition

Interface	osid.topology.NodeQuery
Implements	`osid.OsidObjectQuery`
Used By	`osid.topology.EdgeQuery`
	`osid.topology.GraphQuery`
	`osid.topology.NodeQuerySession`
	`osid.topology.NodeSearchSession`
	`osid.topology.NodeSmartGraphSession`
	`osid.topology.path.PathQuery`
Description	This is the query for searching nodes. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchEdgeId
Description	Sets the edge `Id` for this query to match nodes that have a related edge.
Parameters	`osid.id.Id`	`edgeId`	an edge `Id`
Parameters	`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 `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsEdgeQuery
Description	Tests if a `EdgeQuery` is available.
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 `OR` term.
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 `Id` for this query.
Parameters	`osid.id.Id`	`graphId`	the graph `Id`
Parameters	`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 `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsGraphQuery
Description	Tests if a `GraphQuery` is available.
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 `OR` term.
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 `Node` record `Type`.Multiple record retrievals produce a nested `OR` term.
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.