OSID Logo
OSID Specifications
topology rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.topology.rules.TopologyRulesProxyManager
Implementsosid.OsidProxyManager
osid.topology.rules.TopologyRulesProfile
Description

The topology rules proxy manager provides access to topology rules sessions and provides interoperability tests for various aspects of this service. Methods in this manager pass a Proxy for passing information from server environments. 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
MethodgetEdgeEnablerLookupSession
Description

Gets the OsidSession associated with the edge enabler lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.topology.rules.EdgeEnablerLookupSessionan EdgeEnablerLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEdgeEnablerLookup() is false
ComplianceoptionalThis method must be implemented if supportsEdgeEnablerLookup() is true.
MethodgetEdgeEnablerLookupSessionForGraph
Description

Gets the OsidSession associated with the edge enabler lookup service for the given graph.

Parametersosid.id.IdgraphIdthe Id of the Graph
osid.proxy.Proxyproxya proxy
Returnosid.topology.rules.EdgeEnablerLookupSessionan EdgeEnablerLookupSession
ErrorsNOT_FOUNDno Graph found by the given Id
NULL_ARGUMENT graphId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEdgeEnablerLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsEdgeEnablerLookup() and supportsVisibleFederation() are true.
MethodgetEdgeEnablerQuerySession
Description

Gets the OsidSession associated with the edge enabler query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.topology.rules.EdgeEnablerQuerySessionan EdgeEnablerQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEdgeEnablerQuery() is false
ComplianceoptionalThis method must be implemented if supportsEdgeEnablerQuery() is true.
MethodgetEdgeEnablerQuerySessionForGraph
Description

Gets the OsidSession associated with the edge enabler query service for the given graph.

Parametersosid.id.IdgraphIdthe Id of the Graph
osid.proxy.Proxyproxya proxy
Returnosid.topology.rules.EdgeEnablerQuerySessionan EdgeEnablerQuerySession
ErrorsNOT_FOUNDno Graph found by the given Id
NULL_ARGUMENT graphId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEdgeEnablerQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsEdgeEnablerQuery() and supportsVisibleFederation() are true.
MethodgetEdgeEnablerSearchSession
Description

Gets the OsidSession associated with the edge enabler search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.topology.rules.EdgeEnablerSearchSessionan EdgeEnablerSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEdgeEnablerSearch() is false
ComplianceoptionalThis method must be implemented if supportsEdgeEnablerSearch() is true.
MethodgetEdgeEnablerSearchSessionForGraph
Description

Gets the OsidSession associated with the edge enablers earch service for the given graph.

Parametersosid.id.IdgraphIdthe Id of the Graph
osid.proxy.Proxyproxya proxy
Returnosid.topology.rules.EdgeEnablerSearchSessionan EdgeEnablerSearchSession
ErrorsNOT_FOUNDno Graph found by the given Id
NULL_ARGUMENT graphId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEdgeEnablerSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsEdgeEnablerSearch() and supportsVisibleFederation() are true.
MethodgetEdgeEnablerAdminSession
Description

Gets the OsidSession associated with the edge enabler administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.topology.rules.EdgeEnablerAdminSessionan EdgeEnablerAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEdgeEnablerAdmin() is false
ComplianceoptionalThis method must be implemented if supportsEdgeEnablerAdmin() is true.
MethodgetEdgeEnablerAdminSessionForGraph
Description

Gets the OsidSession associated with the edge enabler administration service for the given graph.

Parametersosid.id.IdgraphIdthe Id of the Graph
osid.proxy.Proxyproxya proxy
Returnosid.topology.rules.EdgeEnablerAdminSessionan EdgeEnablerAdminSession
ErrorsNOT_FOUNDno Graph found by the given Id
NULL_ARGUMENT graphId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEdgeEnablerAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsEdgeEnablerAdmin() and supportsVisibleFederation() are true.
MethodgetEdgeEnablerNotificationSession
Description

Gets the OsidSession associated with the edge enabler notification service.

Parametersosid.topology.rules.EdgeEnablerReceiveredgeEnablerReceiverthe notification callback
osid.proxy.Proxyproxya proxy
Returnosid.topology.rules.EdgeEnablerNotificationSessionan EdgeEnablerNotificationSession
ErrorsNULL_ARGUMENT edgeEnablerReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEdgeEnablerNotification() is false
ComplianceoptionalThis method must be implemented if supportsEdgeEnablerNotification() is true.
MethodgetEdgeEnablerNotificationSessionForGraph
Description

Gets the OsidSession associated with the edge enabler notification service for the given graph.

Parametersosid.topology.rules.EdgeEnablerReceiveredgeEnablerReceiverthe notification callback
osid.id.IdgraphIdthe Id of the Graph
osid.proxy.Proxyproxya proxy
Returnosid.topology.rules.EdgeEnablerNotificationSessionan EdgeEnablerNotificationSession
ErrorsNOT_FOUNDno graph found by the given Id
NULL_ARGUMENT edgeEnablerReceiver, graphId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEdgeEnablerNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsEdgeEnablerNotification() and supportsVisibleFederation() are true.
MethodgetEdgeEnablerGraphSession
Description

Gets the OsidSession to lookup edge enabler/graph mappings for edge enablers.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.topology.rules.EdgeEnablerGraphSessionan EdgeEnablerGraphSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEdgeEnablerGraph() is false
ComplianceoptionalThis method must be implemented if supportsEdgeEnablerGraph() is true.
MethodgetEdgeEnablerGraphAssignmentSession
Description

Gets the OsidSession associated with assigning edge enablers to ontologies for edge.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.topology.rules.EdgeEnablerGraphAssignmentSessionan EdgeEnablerGraphAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEdgeEnablerGraphAssignment() is false
ComplianceoptionalThis method must be implemented if supportsEdgeEnablerGraphAssignment() is true.
MethodgetEdgeEnablerSmartGraphSession
Description

Gets the OsidSession to manage edge enabler smart ontologies.

Parametersosid.id.IdgraphIdthe Id of the Graph
osid.proxy.Proxyproxya proxy
Returnosid.topology.rules.EdgeEnablerSmartGraphSessionan EdgeEnablerSmartGraphSession
ErrorsNOT_FOUNDno Graph found by the given Id
NULL_ARGUMENT graphId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEdgeEnablerSmartGraph() is false
ComplianceoptionalThis method must be implemented if supportsEdgeEnablerSmartGraph() is true.
MethodgetEdgeEnablerRuleLookupSession
Description

Gets the OsidSession associated with the edge enabler mapping lookup service for looking up the rules applied to the graph.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.topology.rules.EdgeEnablerRuleLookupSessionan EdgeEnablerRuleLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEdgeEnablerRuleLookup() is false
ComplianceoptionalThis method must be implemented if supportsEdgeEnablerRuleLookup() is true.
MethodgetEdgeEnablerRuleLookupSessionForGraph
Description

Gets the OsidSession associated with the edge enabler mapping lookup service for the given graph for looking up rules applied to a graph.

Parametersosid.id.IdgraphIdthe Id of the Graph
osid.proxy.Proxyproxya proxy
Returnosid.topology.rules.EdgeEnablerRuleLookupSessionan EdgeEnablerRuleLookupSession
ErrorsNOT_FOUNDno Graph found by the given Id
NULL_ARGUMENT graphId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEdgeEnablerRuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsEdgeEnablerRuleLookup() and supportsVisibleFederation() are true.
MethodgetEdgeEnablerRuleApplicationSession
Description

Gets the OsidSession associated with the edge enabler assignment service to apply enablers to ontologies.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.topology.rules.EdgeEnablerRuleApplicationSessionan EdgeEnablerRuleApplicationSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEdgeEnablerRuleApplication() is false
ComplianceoptionalThis method must be implemented if supportsEdgeEnablerRuleApplication() is true.
MethodgetEdgeEnablerRuleApplicationSessionForGraph
Description

Gets the OsidSession associated with the edge enabler assignment service for the given graph to apply enablers to ontologies.

Parametersosid.id.IdgraphIdthe Id of the Graph
osid.proxy.Proxyproxya proxy
Returnosid.topology.rules.EdgeEnablerRuleApplicationSessionan EdgeEnablerRuleApplicationSession
ErrorsNOT_FOUNDno Graph found by the given Id
NULL_ARGUMENT graphId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEdgeEnablerRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsEdgeEnablerRuleApplication() and supportsVisibleFederation() are true.