OSID - osid.topology.EdgeQuery Service Interface Definition

Interface	osid.topology.EdgeQuery
Implements	`osid.OsidRelationshipQuery`
Description	This is the query for searching edges. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR.`
Method	matchSourceNodeId
Description	Sets the node `Id` for this query to match edges assigned to nodes.
Parameters	`osid.id.Id`	`nodeId`	the node `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`nodeId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearSourceNodeIdTerms
Description	Clears the node `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsSourceNodeQuery
Description	Tests if a `NodeQuery` is available.
Return	`boolean`		`true` if a node query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSourceNodeQuery
Description	Gets the query for a node. Multiple retrievals produce a nested `OR` term.
Return	`osid.topology.NodeQuery`		the node query
Errors	UNIMPLEMENTED		`supportsSourceNodeQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSourceNodeQuery()` is `true.`
Method	clearSourceNodeTerms
Description	Clears the node terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDestinationNodeId
Description	Sets the related node `Id` for this query to match edges assigned to nodes.
Parameters	`osid.id.Id`	`nodeId`	the node `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`nodeId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDestinationNodeIdTerms
Description	Clears the related node `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDestinationNodeQuery
Description	Tests if a `NodeQuery` is available.
Return	`boolean`		`true` if a node query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDestinationNodeQuery
Description	Gets the query for a related node. Multiple retrievals produce a nested `OR` term.
Return	`osid.topology.NodeQuery`		the node query
Errors	UNIMPLEMENTED		`supportsDestinationNodeQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDestinationNodeQuery()` is `true.`
Method	clearDestinationNodeTerms
Description	Clears the related node terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchSameNode
Description	Matches edges between the same node.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearSameNodeTerms
Description	Clears the same node terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDirectional
Description	Matches directional edges.
Parameters	`boolean`	`match`	`true` to match directional edges, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	clearDirectionalTerms
Description	Clears the directional terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchBiDirectional
Description	Matches bi-directional edges.
Parameters	`boolean`	`match`	`true` to match bi-directional edges, `false` to match uni-directional edges
Compliance	`mandatory`		This method must be implemented.
Method	clearBiDirectionalTerms
Description	Clears the directional terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCost
Description	Matches edges that have the specified cost inclusive.
Parameters	`decimal`	`from`	starting range
	`decimal`	`to`	ending range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`to` is less than `from`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyCost
Description	Matches edges that has any cost assigned.
Parameters	`boolean`	`match`	`true` to match edges with any cost, `false` to match edges with no cost assigned
Compliance	`mandatory`		This method must be implemented.
Method	clearCostTerms
Description	Clears the cost terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDistance
Description	Matches edges that have the specified distance inclusive.
Parameters	`decimal`	`from`	starting range
	`decimal`	`to`	ending range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`to` is less than `from`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyDistance
Description	Matches edges that has any distance assigned.
Parameters	`boolean`	`match`	`true` to match edges with any distance, `false` to match edges with no distance assigned
Compliance	`mandatory`		This method must be implemented.
Method	clearDistanceTerms
Description	Clears the distance terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchGraphId
Description	Sets the graph `Id` for this query to match edges assigned to graphs.
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	getEdgeQueryRecord
Description	Gets the edge query record corresponding to the given `Edge` record `Type.` Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`edgeRecordType`	an edge record type
Return	`osid.topology.records.EdgeQueryRecord`		the edge query record
Errors	NULL_ARGUMENT		`edgeRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(edgeRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.