OSID - osid.topology.path.PathQuery Service Interface Definition

Interface	osid.topology.path.PathQuery
Implements	`osid.OsidRelationshipQuery`
Implements	`osid.OsidAggregateableQuery`
Used By	`osid.topology.path.PathQuery`
	`osid.topology.path.PathQuerySession`
	`osid.topology.path.PathSearchSession`
	`osid.topology.path.PathSmartGraphSession`
Description	This is the query for searching paths. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchComplete
Description	Matches paths that are complete.
Parameters	`boolean`	`match`	`true` to match complete paths, `false` to match inactive paths
Compliance	`mandatory`		This method must be implemented.
Method	clearCompleteTerms
Description	Clears the path complete query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchClosed
Description	Matches paths that are closed.
Parameters	`boolean`	`match`	`true` to match closed paths, `false` to match inactive paths
Compliance	`mandatory`		This method must be implemented.
Method	clearClosedTerms
Description	Clears the path closed query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchStartingNodeId
Description	Sets the node `Id` for this query to match paths with a starting node.
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	clearStartingNodeIdTerms
Description	Clears the starting node `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsStartingNodeQuery
Description	Tests if a `NodeQuery` is available for a starting node.
Return	`boolean`		`true` if a node query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getStartingNodeQuery
Description	Gets the query for a starting node. Multiple retrievals produce a nested `OR` term.
Return	`osid.topology.NodeQuery`		the node query
Errors	UNIMPLEMENTED		`supportsStartingNodeQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStartingNodeQuery()` is `true`.
Method	clearStartingNodeTerms
Description	Clears the starting node query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchEndingNodeId
Description	Sets the node `Id` for this query to match paths with an ending node.
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	clearEndingNodeIdTerms
Description	Clears the ending node `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsEndingNodeQuery
Description	Tests if a `NodeQuery` is available for an ending node.
Return	`boolean`		`true` if a node query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getEndingNodeQuery
Description	Gets the query for an ending node. Multiple retrievals produce a nested `OR` term.
Return	`osid.topology.NodeQuery`		the node query
Errors	UNIMPLEMENTED		`supportsEndingNodeQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEndingNodeQuery()` is `true`.
Method	clearEndingNodeTerms
Description	Clears the ending node query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAlongNodeIds
Description	Sets the node `Ids` for this query to match paths along the given nodes.
Parameters	`osid.id.Id[]`	`nodeIds`	the node `Ids`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`nodeIds` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAlongNodeIdsTerms
Description	Clears the along node `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchIntersectingPathId
Description	Sets the path `Id` for this query to match paths intersecting with another path.
Parameters	`osid.id.Id`	`pathId`	the path `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`pathId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearIntersectingPathIdTerms
Description	Clears the intersecting path `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsIntersectingPathQuery
Description	Tests if a `PathQuery` is available for intersecting paths,
Return	`boolean`		`true` if a path query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getIntersectingPathQuery
Description	Gets the query for an intersecting path, Multiple retrievals produce a nested `OR` term.
Return	`osid.topology.path.PathQuery`		the path query
Errors	UNIMPLEMENTED		`supportsIntersectingPathQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsIntersectingPathQuery()` is `true`.
Method	matchAnyIntersectingPath
Description	Matches paths with any intersecting path,
Parameters	`boolean`	`match`	`true` to match paths with any intersecting path, `false` to match paths with no intersecting path
Compliance	`mandatory`		This method must be implemented.
Method	clearIntersectingPathTerms
Description	Clears the intersecting path query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchHops
Description	Matches paths that have a number of hops within the given range inclusive.
Parameters	`cardinal`	`from`	starting range
	`cardinal`	`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	clearHopsTerms
Description	Clears the number of hops query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDistance
Description	Matches paths that have a distance with the given range 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 paths that has any distance assigned.
Parameters	`boolean`	`match`	`true` to match paths with any distance, `false` to match paths with no distance assigned
Compliance	`mandatory`		This method must be implemented.
Method	clearDistanceTerms
Description	Clears the distance query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCost
Description	Matches paths that have a cost with the given range 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	clearCostTerms
Description	Clears the cost query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchNodeId
Description	Sets the node `Id` for this query to match paths that pass through 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	clearNodeIdTerms
Description	Clears the node `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsNodeQuery
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	getNodeQuery
Description	Gets the query for a node. Multiple retrievals produce a nested `OR` term.
Return	`osid.topology.NodeQuery`		the node query
Errors	UNIMPLEMENTED		`supportsNodeQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsNodeQuery()` is `true`.
Method	clearNodeTerms
Description	Clears the node query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchEdgeId
Description	Sets the edge `Id` for this query to match paths contain the edge.
Parameters	`osid.id.Id`	`edgeId`	the edge `Id`
Parameters	`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 `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsEdgeQuery
Description	Tests if an `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 query 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	getPathQueryRecord
Description	Gets the path query record corresponding to the given `Path` record `Type`.Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`pathRecordType`	a path record type
Return	`osid.topology.path.records.PathQueryRecord`		the path query record
Errors	NULL_ARGUMENT		`pathRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(pathRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.