OSID - osid.topology.EdgeSmartGraphSession Service Interface Definition

Interface	osid.topology.EdgeSmartGraphSession
Implements	`osid.OsidSession`
Used By	`osid.topology.TopologyManager`
Used By	`osid.topology.TopologyProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. An `EdgeQuery` can be retrieved from this session and mapped to this `Graph` to create a virtual collection of `Edges` . The entries may be sequenced using the `EdgeSearchOrder` from this session. This `Graph` has a default query that matches any edge and a default search order that specifies no sequencing. The queries may be examined using an `EdgeQueryInspector` . The query may be modified by converting the inspector back to an `EdgeQuery` .
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	canManageSmartGraphs
Description	Tests if this user can manage smart graphs. 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 opt not to offer smart operations.
Return	`boolean`		`false` if smart graph methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getEdgeQuery
Description	Gets an edge query.
Return	`osid.topology.EdgeQuery`		the edge query
Compliance	`mandatory`		This method must be implemented.
Method	getEdgeSearchOrder
Description	Gets an edge search order.
Return	`osid.topology.EdgeSearchOrder`		the edge search order
Compliance	`mandatory`		This method must be implemented.
Method	applyEdgeQuery
Description	Applies an edge query to this graph.
Parameters	`osid.topology.EdgeQuery`	`edgeQuery`	the edge query
Errors	NULL_ARGUMENT		`edgeQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`edgeQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectEdgeQuery
Description	Gets an edge query inspector for this graph.
Return	`osid.topology.EdgeQueryInspector`		the edge query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyEdgeSequencing
Description	Applies an edge search order to this graph.
Parameters	`osid.topology.EdgeSearchOrder`	`edgeSearchOrder`	the edge search order
Errors	NULL_ARGUMENT		`edgeSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`edgeSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getEdgeQueryFromInspector
Description	Gets an edge query from an inspector.
Parameters	`osid.topology.EdgeQueryInspector`	`edgeQueryInspector`	an edge query inspector
Return	`osid.topology.EdgeQuery`		the edge query
Errors	NULL_ARGUMENT		`relatinshipQueryInspector` is `null`
Errors	UNSUPPORTED		`edgeQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.