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

Interface	osid.topology.rules.EdgeEnablerQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.topology.rules.EdgeEnablerSearchSession`
Used By	`osid.topology.rules.TopologyRulesManager`
Used By	`osid.topology.rules.TopologyRulesProxyManager`
Description	This session provides methods for searching among `EdgeEnabler` objects. The search query is constructed using the `EdgeEnablerQuery`. This session defines views that offer differing behaviors for searching. federated graph view: searches include edge enablers in ontologies of which this graph is an ancestor in the graph hierarchy isolated graph view: searches are restricted to edge enablers in this graph Edge enablers may have a query record indicated by their respective record types. The query record is accessed via the `EdgeEnablerQuery`.
Method	getGraphId
Description	Gets the `Graph` `Id` associated with this session.
Return	`osid.id.Id`		the `Graph Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getGraph
Description	Gets the `Graph` associated with this session.
Return	`osid.topology.Graph`		the graph
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSearchEdgeEnablers
Description	Tests if this user can perform `EdgeEnabler` lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedGraphView
Description	Federates the view for methods in this session. A federated view will include edge enablers in ontologies which are children of this broker in the graph hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedGraphView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this graph only.
Compliance	`mandatory`		This method is must be implemented.
Method	getEdgeEnablerQuery
Description	Gets an edge enabler query.
Return	`osid.topology.rules.EdgeEnablerQuery`		the edge enabler query
Compliance	`mandatory`		This method must be implemented.
Method	getEdgeEnablersByQuery
Description	Gets a list of `EdgeEnablers` matching the given edge enabler query.
Parameters	`osid.topology.rules.EdgeEnablerQuery`	`edgeEnablerQuery`	the edge enabler query query
Return	`osid.topology.rules.EdgeEnablerList`		the returned `EdgeEnablerList`
Errors	NULL_ARGUMENT		`edgeEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`edgeEnablerQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.