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

Interface	osid.topology.rules.TopologyRulesManager
Implements	`osid.OsidManager`
Implements	`osid.topology.rules.TopologyRulesProfile`
Description	The topology rules manager provides access to topology rules sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are: `EdgeEnablerLookupSession:` a session to retrieve edge enablers `EdgeEnablerQuerySession:` a session to query for edge enablers `EdgeEnablerSearchSession:` a session to search for edge enablers `EdgeEnablerAdminSession:` a session to create and delete edge enablers `EdgeEnablerNotificationSession:` a session to receive notifications pertaining to edge enabler changes `EdgeEnablerGraphSession:` a session to look up edge enabler graph mappings `EdgeEnablerGraphAssignmentSession:` a session to manage edge enabler to graph mappings `EdgeEnablerSmartGraphSession:` a session to manage dynamic ontologies of edge enablers `EdgeEnablerRuleLookupSession:` a session to look up edge enabler to edge mappings `EdgeEnablerRuleApplicationSession:` a session to apply edge enablers to edges
Method	getEdgeEnablerLookupSession
Description	Gets the `OsidSession` associated with the edge enabler lookup service.
Return	`osid.topology.rules.EdgeEnablerLookupSession`		an `EdgeEnablerLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsEdgeEnablerLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEdgeEnablerLookup()` is `true.`
Method	getEdgeEnablerLookupSessionForGraph
Description	Gets the `OsidSession` associated with the edge enabler lookup service for the given graph.
Parameters	`osid.id.Id`	`graphId`	the `Id` of the `Graph`
Return	`osid.topology.rules.EdgeEnablerLookupSession`		an `EdgeEnablerLookupSession`
Errors	NOT_FOUND		no `Graph` found by the given `Id`
	NULL_ARGUMENT		`graphId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsEdgeEnablerLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEdgeEnablerLookup()` and `supportsVisibleFederation()` are `true.`
Method	getEdgeEnablerQuerySession
Description	Gets the `OsidSession` associated with the edge enabler query service.
Return	`osid.topology.rules.EdgeEnablerQuerySession`		an `EdgeEnablerQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsEdgeEnablerQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEdgeEnablerQuery()` is `true.`
Method	getEdgeEnablerQuerySessionForGraph
Description	Gets the `OsidSession` associated with the edge enabler query service for the given graph.
Parameters	`osid.id.Id`	`graphId`	the `Id` of the `Graph`
Return	`osid.topology.rules.EdgeEnablerQuerySession`		an `EdgeEnablerQuerySession`
Errors	NOT_FOUND		no `Graph` found by the given `Id`
	NULL_ARGUMENT		`graphId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsEdgeEnablerQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEdgeEnablerQuery()` and `supportsVisibleFederation()` are `true.`
Method	getEdgeEnablerSearchSession
Description	Gets the `OsidSession` associated with the edge enabler search service.
Return	`osid.topology.rules.EdgeEnablerSearchSession`		an `EdgeEnablerSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsEdgeEnablerSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEdgeEnablerSearch()` is `true.`
Method	getEdgeEnablerSearchSessionForGraph
Description	Gets the `OsidSession` associated with the edge enablers earch service for the given graph.
Parameters	`osid.id.Id`	`graphId`	the `Id` of the `Graph`
Return	`osid.topology.rules.EdgeEnablerSearchSession`		an `EdgeEnablerSearchSession`
Errors	NOT_FOUND		no `Graph` found by the given `Id`
	NULL_ARGUMENT		`graphId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsEdgeEnablerSearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEdgeEnablerSearch()` and `supportsVisibleFederation()` are `true.`
Method	getEdgeEnablerAdminSession
Description	Gets the `OsidSession` associated with the edge enabler administration service.
Return	`osid.topology.rules.EdgeEnablerAdminSession`		an `EdgeEnablerAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsEdgeEnablerAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEdgeEnablerAdmin()` is `true.`
Method	getEdgeEnablerAdminSessionForGraph
Description	Gets the `OsidSession` associated with the edge enabler administration service for the given graph.
Parameters	`osid.id.Id`	`graphId`	the `Id` of the `Graph`
Return	`osid.topology.rules.EdgeEnablerAdminSession`		an `EdgeEnablerAdminSession`
Errors	NOT_FOUND		no `Graph` found by the given `Id`
	NULL_ARGUMENT		`graphId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsEdgeEnablerAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEdgeEnablerAdmin()` and `supportsVisibleFederation()` are `true.`
Method	getEdgeEnablerNotificationSession
Description	Gets the `OsidSession` associated with the edge enabler notification service.
Parameters	`osid.topology.rules.EdgeEnablerReceiver`	`edgeEnablerReceiver`	the notification callback
Return	`osid.topology.rules.EdgeEnablerNotificationSession`		an `EdgeEnablerNotificationSession`
Errors	NULL_ARGUMENT		`edgeEnablerReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsEdgeEnablerNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEdgeEnablerNotification()` is `true.`
Method	getEdgeEnablerNotificationSessionForGraph
Description	Gets the `OsidSession` associated with the edge enabler notification service for the given graph.
Parameters	`osid.topology.rules.EdgeEnablerReceiver`	`edgeEnablerReceiver`	the notification callback
Parameters	`osid.id.Id`	`graphId`	the `Id` of the `Graph`
Return	`osid.topology.rules.EdgeEnablerNotificationSession`		an `EdgeEnablerNotificationSession`
Errors	NOT_FOUND		no graph found by the given `Id`
	NULL_ARGUMENT		`edgeEnablerReceiver` or `graphId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsEdgeEnablerNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEdgeEnablerNotification()` and `supportsVisibleFederation()` are `true.`
Method	getEdgeEnablerGraphSession
Description	Gets the `OsidSession` to lookup edge enabler/graph mappings for edge enablers.
Return	`osid.topology.rules.EdgeEnablerGraphSession`		an `EdgeEnablerGraphSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsEdgeEnablerGraph()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEdgeEnablerGraph()` is `true.`
Method	getEdgeEnablerGraphAssignmentSession
Description	Gets the `OsidSession` associated with assigning edge enablers to ontologies for edge.
Return	`osid.topology.rules.EdgeEnablerGraphAssignmentSession`		an `EdgeEnablerGraphAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsEdgeEnablerGraphAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEdgeEnablerGraphAssignment()` is `true.`
Method	getEdgeEnablerSmartGraphSession
Description	Gets the `OsidSession` to manage edge enabler smart ontologies.
Parameters	`osid.id.Id`	`graphId`	the `Id` of the `Graph`
Return	`osid.topology.rules.EdgeEnablerSmartGraphSession`		an `EdgeEnablerSmartGraphSession`
Errors	NOT_FOUND		no `Graph` found by the given `Id`
	NULL_ARGUMENT		`graphId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsEdgeEnablerSmartGraph()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEdgeEnablerSmartGraph()` is `true.`
Method	getEdgeEnablerRuleLookupSession
Description	Gets the `OsidSession` associated with the edge enabler mapping lookup service for looking up the rules applied to the graph.
Return	`osid.topology.rules.EdgeEnablerRuleLookupSession`		an `EdgeEnablerRuleLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsEdgeEnablerRuleLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEdgeEnablerRuleLookup()` is `true.`
Method	getEdgeEnablerRuleLookupSessionForGraph
Description	Gets the `OsidSession` associated with the edge enabler mapping lookup service for the given graph for looking up rules applied to a graph.
Parameters	`osid.id.Id`	`graphId`	the `Id` of the `Graph`
Return	`osid.topology.rules.EdgeEnablerRuleLookupSession`		an `EdgeEnablerRuleLookupSession`
Errors	NOT_FOUND		no `Graph` found by the given `Id`
	NULL_ARGUMENT		`graphId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsEdgeEnablerRuleLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEdgeEnablerRuleLookup()` and `supportsVisibleFederation()` are `true.`
Method	getEdgeEnablerRuleApplicationSession
Description	Gets the `OsidSession` associated with the edge enabler assignment service to apply enablers to ontologies.
Return	`osid.topology.rules.EdgeEnablerRuleApplicationSession`		an `EdgeEnablerRuleApplicationSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsEdgeEnablerRuleApplication()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEdgeEnablerRuleApplication()` is `true.`
Method	getEdgeEnablerRuleApplicationSessionForGraph
Description	Gets the `OsidSession` associated with the edge enabler assignment service for the given graph to apply enablers to ontologies.
Parameters	`osid.id.Id`	`graphId`	the `Id` of the `Graph`
Return	`osid.topology.rules.EdgeEnablerRuleApplicationSession`		an `EdgeEnablerRuleApplicationSession`
Errors	NOT_FOUND		no `Graph` found by the given `Id`
	NULL_ARGUMENT		`graphId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsEdgeEnablerRuleApplication()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEdgeEnablerRuleApplication()` and `supportsVisibleFederation()` are `true.`