OSID - osid.topology.NodeSmartGraphSession Service Interface Definition

Interface	osid.topology.NodeSmartGraphSession
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. A `NodeQuery` can be retrieved from this session and mapped to this `Graph` to create a virtual collection of `Nodes`. The entries may be sequenced using the `NodeSearchOrder` from this session. This `Graph` has a default query that matches any node and a default search order that specifies no sequencing. The queries may be examined using a `NodeQueryInspector`. The query may be modified by converting the inspector back to a `NodeQuery`.
Method	getGraphId
Description	Gets the `Familt` `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	getNodeQuery
Description	Gets a node query.
Return	`osid.topology.NodeQuery`		the node query
Compliance	`mandatory`		This method must be implemented.
Method	getNodeSearchOrder
Description	Gets a node search order.
Return	`osid.topology.NodeSearchOrder`		the node search order
Compliance	`mandatory`		This method must be implemented.
Method	applyNodeQuery
Description	Applies a node query to this graph.
Parameters	`osid.topology.NodeQuery`	`nodeQuery`	the node query
Errors	NULL_ARGUMENT		`nodeQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`nodeQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectNodeQuery
Description	Gets a node query inspector for this graph.
Return	`osid.topology.NodeQueryInspector`		the node query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyNodeSequencing
Description	Applies a node search order to this graph.
Parameters	`osid.topology.NodeSearchOrder`	`nodeSearchOrder`	the node search order
Errors	NULL_ARGUMENT		`nodeSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`nodeSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getNodeQueryFromInspector
Description	Gets a node query from an inspector.
Parameters	`osid.topology.NodeQueryInspector`	`nodeQueryInspector`	a node query inspector
Return	`osid.topology.NodeQuery`		the node query
Errors	NULL_ARGUMENT		`relatinshipQueryInspector` is `null`
Errors	UNSUPPORTED		`nodeQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.