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

Interface	osid.topology.rules.EdgeEnablerSmartGraphSession
Implements	`osid.OsidSession`
Used By	`osid.topology.rules.TopologyRulesManager`
Used By	`osid.topology.rules.TopologyRulesProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic ontologies. An `EdgeEnablerQuery` can be retrieved from this session and mapped to this `Graph` to create a virtual collection of edge enablers. The edge enablers may be sequenced using the `EdgeEnablerSearchOrder` from this session. This `Graph` has a default query that matches any edge enabler and a default search order that specifies no sequencing. The queries may be examined using an `EdgeEnablerQueryInspector`. The query may be modified by converting the inspector back to an `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	canManageSmartOntologies
Description	Tests if this user can manage smart ontologies. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.
Return	`boolean`		`false` if smart graph management is not authorized, `true` otherwise
Compliance	`mandatory`		This method 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	getEdgeEnablerSearchOrder
Description	Gets an edge enabler search order.
Return	`osid.topology.rules.EdgeEnablerSearchOrder`		the edge enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	applyEdgeEnablerQuery
Description	Applies an edge enabler query to this graph.
Parameters	`osid.topology.rules.EdgeEnablerQuery`	`edgeEnablerQuery`	the edge enabler query
Errors	NULL_ARGUMENT		`edgeEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`edgeEnablerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectEdgeEnablerQuery
Description	Gets an edge enabler query inspector for this graph.
Return	`osid.topology.rules.EdgeEnablerQueryInspector`		the edge enabler query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyEdgeEnablerSequencing
Description	Applies an edge enabler search order to this graph.
Parameters	`osid.topology.rules.EdgeEnablerSearchOrder`	`edgeEnablerSearchOrder`	the edge enabler search order
Errors	NULL_ARGUMENT		`edgeEnablerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`edgeEnablerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getEdgeEnablerQueryFromInspector
Description	Gets an edge enabler query from an inspector.
Parameters	`osid.topology.rules.EdgeEnablerQueryInspector`	`edgeEnablerQueryInspector`	an edge enabler query inspector
Return	`osid.topology.rules.EdgeEnablerQuery`		the edge enabler query
Errors	NULL_ARGUMENT		`edgeEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`edgeEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.