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

Interface	osid.topology.rules.EdgeEnablerRuleLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods to retrieve `EdgeEnabler` to `Edge` mappings. An `Edge` with multiple `EdgeEnablers` means any positive rule evaluation across the enablers result in an effective `Edge.` This lookup session defines several views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition isolated graph view: All methods in this session operate, retrieve and pertain edge enablers defined explicitly in the current graph federated graph view: All methods in this session operate, retrieve and pertain to all edge enablers defined in this graph and any other edge enablers implicitly available in this graph through graph inheritence.
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	canLookupEdgeEnablerRules
Description	Tests if this user can perform lookups of edge enabler/edge mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 lookup operations to unauthorized users.
Return	`boolean`		`false` if looking up mappings is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeEdgeEnablerRuleView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryEdgeEnablerRuleView
Description	A complete view of the `EdgeEnabler` and `Edge` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is 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 graph 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	getEdgeEnablerIdsForEdge
Description	Gets the `EdgeEnabler Id` associated with an `Edge.`
Parameters	`osid.id.Id`	`edgeId`	`Id` of the `Edge`
Return	`osid.id.IdList`		the edge enabler `Ids`
Errors	NOT_FOUND		`edgeId` is not found
	NULL_ARGUMENT		`edgeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEdgeEnablersForEdge
Description	Gets the `EdgeEnabler` associated with an `Edge.`
Parameters	`osid.id.Id`	`edgeId`	`Id` of the `Edge`
Return	`osid.topology.rules.EdgeEnablerList`		the edge enablers
Errors	NOT_FOUND		`edgeId` is not found
	NULL_ARGUMENT		`edgeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEdgeIdsByEdgeEnabler
Description	Gets the `Edge` `Ids` mapped to an `EdgeEnabler.`
Parameters	`osid.id.Id`	`edgeEnablerId`	`Id` of an `EdgeEnabler`
Return	`osid.id.IdList`		list of edge `Ids`
Errors	NOT_FOUND		`edgeEnablerId` is not found
	NULL_ARGUMENT		`edgeEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEdgesByEdgeEnabler
Description	Gets the `Edges` mapped to an `EdgeEnabler.`
Parameters	`osid.id.Id`	`edgeEnablerId`	`Id` of an `EdgeEnabler`
Return	`osid.topology.EdgeList`		list of edges
Errors	NOT_FOUND		`edgeEnablerId` is not found
	NULL_ARGUMENT		`edgeEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.