OSID - osid.topology.rules.EdgeEnablerQuery Service Interface Definition

Interface	osid.topology.rules.EdgeEnablerQuery
Implements	`osid.OsidEnablerQuery`
Used By	`osid.topology.rules.EdgeEnablerQuerySession`
	`osid.topology.rules.EdgeEnablerSearchSession`
	`osid.topology.rules.EdgeEnablerSmartGraphSession`
Description	This is the query for searching edge enablers. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchRuledEdgeId
Description	Matches enablers mapped to 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	clearRuledEdgeIdTerms
Description	Clears the edge `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledEdgeQuery
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	getRuledEdgeQuery
Description	Gets the query for an edge. Multiple retrievals produce a nested `OR` term.
Return	`osid.topology.EdgeQuery`		the edge query
Errors	UNIMPLEMENTED		`supportsRuledEdgeQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuledEdgeQuery()` is `true`.
Method	matchAnyRuledEdge
Description	Matches enablers mapped to any edge.
Parameters	`boolean`	`match`	`true` for enablers mapped to any edge, `false` to match enablers mapped to no edge
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledEdgeTerms
Description	Clears the edge query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchGraphId
Description	Matches enablers mapped to the graph.
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` query 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 query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getEdgeEnablerQueryRecord
Description	Gets the edge enabler query record corresponding to the given `EdgeEnabler` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`edgeEnablerRecordType`	an edge enabler record type
Return	`osid.topology.rules.records.EdgeEnablerQueryRecord`		the edge enabler query record
Errors	NULL_ARGUMENT		`edgeEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(edgeEnablerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.