public interface TopologyRulesProxyManager extends OsidProxyManager, TopologyRulesProfile
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 Modifier and Type | Method and Description |
---|---|
EdgeEnablerAdminSession |
getEdgeEnablerAdminSession(Proxy proxy)
Gets the
OsidSession associated with the edge enabler
administration service. |
EdgeEnablerAdminSession |
getEdgeEnablerAdminSessionForGraph(Id graphId,
Proxy proxy)
Gets the
OsidSession associated with the edge enabler
administration service for the given graph. |
EdgeEnablerGraphAssignmentSession |
getEdgeEnablerGraphAssignmentSession(Proxy proxy)
Gets the
OsidSession associated with assigning edge
enablers to ontologies for edge. |
EdgeEnablerGraphSession |
getEdgeEnablerGraphSession(Proxy proxy)
Gets the
OsidSession to lookup edge enabler/graph
mappings for edge enablers. |
EdgeEnablerLookupSession |
getEdgeEnablerLookupSession(Proxy proxy)
Gets the
OsidSession associated with the edge enabler
lookup service. |
EdgeEnablerLookupSession |
getEdgeEnablerLookupSessionForGraph(Id graphId,
Proxy proxy)
Gets the
OsidSession associated with the edge enabler
lookup service for the given graph. |
EdgeEnablerNotificationSession |
getEdgeEnablerNotificationSession(EdgeEnablerReceiver edgeEnablerReceiver,
Proxy proxy)
Gets the
OsidSession associated with the edge enabler
notification service. |
EdgeEnablerNotificationSession |
getEdgeEnablerNotificationSessionForGraph(EdgeEnablerReceiver edgeEnablerReceiver,
Id graphId,
Proxy proxy)
Gets the
OsidSession associated with the edge enabler
notification service for the given graph. |
EdgeEnablerQuerySession |
getEdgeEnablerQuerySession(Proxy proxy)
Gets the
OsidSession associated with the edge enabler
query service. |
EdgeEnablerQuerySession |
getEdgeEnablerQuerySessionForGraph(Id graphId,
Proxy proxy)
Gets the
OsidSession associated with the edge enabler
query service for the given graph. |
EdgeEnablerRuleApplicationSession |
getEdgeEnablerRuleApplicationSession(Proxy proxy)
Gets the
OsidSession associated with the edge enabler
assignment service to apply enablers to ontologies. |
EdgeEnablerRuleApplicationSession |
getEdgeEnablerRuleApplicationSessionForGraph(Id graphId,
Proxy proxy)
Gets the
OsidSession associated with the edge enabler
assignment service for the given graph to apply enablers to
ontologies. |
EdgeEnablerRuleLookupSession |
getEdgeEnablerRuleLookupSession(Proxy proxy)
Gets the
OsidSession associated with the edge enabler
mapping lookup service for looking up the rules applied to the graph. |
EdgeEnablerRuleLookupSession |
getEdgeEnablerRuleLookupSessionForGraph(Id graphId,
Proxy proxy)
Gets the
OsidSession associated with the edge enabler
mapping lookup service for the given graph for looking up rules
applied to a graph. |
EdgeEnablerSearchSession |
getEdgeEnablerSearchSession(Proxy proxy)
Gets the
OsidSession associated with the edge enabler
search service. |
EdgeEnablerSearchSession |
getEdgeEnablerSearchSessionForGraph(Id graphId,
Proxy proxy)
Gets the
OsidSession associated with the edge enablers
earch service for the given graph. |
EdgeEnablerSmartGraphSession |
getEdgeEnablerSmartGraphSession(Id graphId,
Proxy proxy)
Gets the
OsidSession to manage edge enabler smart
ontologies. |
changeBranch, initialize, rollbackService
close
getEdgeEnablerRecordTypes, getEdgeEnablerSearchRecordTypes, supportsEdgeEnablerAdmin, supportsEdgeEnablerGraph, supportsEdgeEnablerGraphAssignment, supportsEdgeEnablerLookup, supportsEdgeEnablerNotification, supportsEdgeEnablerQuery, supportsEdgeEnablerRecordType, supportsEdgeEnablerRuleApplication, supportsEdgeEnablerRuleLookup, supportsEdgeEnablerSearch, supportsEdgeEnablerSearchRecordType, supportsEdgeEnablerSmartGraph, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
EdgeEnablerLookupSession getEdgeEnablerLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the edge enabler
lookup service.proxy
- a proxy EdgeEnablerLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsEdgeEnablerLookup()
is false
optional
- This method must be implemented if
supportsEdgeEnablerLookup()
is true.
EdgeEnablerLookupSession getEdgeEnablerLookupSessionForGraph(Id graphId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the edge enabler
lookup service for the given graph.graphId
- the Id
of the Graph
proxy
- a proxy EdgeEnablerLookupSession
NotFoundException
- no Graph
found by
the given Id
NullArgumentException
- graphId or proxy is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsEdgeEnablerLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsEdgeEnablerLookup()
and
supportsVisibleFederation()
are true.
EdgeEnablerQuerySession getEdgeEnablerQuerySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the edge enabler
query service.proxy
- a proxy EdgeEnablerQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsEdgeEnablerQuery()
is false
optional
- This method must be implemented if
supportsEdgeEnablerQuery()
is true.
EdgeEnablerQuerySession getEdgeEnablerQuerySessionForGraph(Id graphId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the edge enabler
query service for the given graph.graphId
- the Id
of the Graph
proxy
- a proxy EdgeEnablerQuerySession
NotFoundException
- no Graph
found by
the given Id
NullArgumentException
- graphId or proxy is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsEdgeEnablerQuery()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsEdgeEnablerQuery()
and
supportsVisibleFederation()
are true.
EdgeEnablerSearchSession getEdgeEnablerSearchSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the edge enabler
search service.proxy
- a proxy EdgeEnablerSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsEdgeEnablerSearch()
is false
optional
- This method must be implemented if
supportsEdgeEnablerSearch()
is true.
EdgeEnablerSearchSession getEdgeEnablerSearchSessionForGraph(Id graphId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the edge enablers
earch service for the given graph.graphId
- the Id
of the Graph
proxy
- a proxy EdgeEnablerSearchSession
NotFoundException
- no Graph
found by
the given Id
NullArgumentException
- graphId or proxy is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsEdgeEnablerSearch()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsEdgeEnablerSearch()
and
supportsVisibleFederation()
are true.
EdgeEnablerAdminSession getEdgeEnablerAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the edge enabler
administration service.proxy
- a proxy EdgeEnablerAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsEdgeEnablerAdmin()
is false
optional
- This method must be implemented if
supportsEdgeEnablerAdmin()
is true.
EdgeEnablerAdminSession getEdgeEnablerAdminSessionForGraph(Id graphId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the edge enabler
administration service for the given graph.graphId
- the Id
of the Graph
proxy
- a proxy EdgeEnablerAdminSession
NotFoundException
- no Graph
found by
the given Id
NullArgumentException
- graphId or proxy is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsEdgeEnablerAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsEdgeEnablerAdmin()
and
supportsVisibleFederation()
are true.
EdgeEnablerNotificationSession getEdgeEnablerNotificationSession(EdgeEnablerReceiver edgeEnablerReceiver, Proxy proxy) throws OperationFailedException
OsidSession
associated with the edge enabler
notification service.edgeEnablerReceiver
- the notification callbackproxy
- a proxy EdgeEnablerNotificationSession
NullArgumentException
- edgeEnablerReceiver
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsEdgeEnablerNotification()
is false
optional
- This method must be implemented if
supportsEdgeEnablerNotification()
is true.
EdgeEnablerNotificationSession getEdgeEnablerNotificationSessionForGraph(EdgeEnablerReceiver edgeEnablerReceiver, Id graphId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the edge enabler
notification service for the given graph.edgeEnablerReceiver
- the notification callbackgraphId
- the Id
of the Graph
proxy
- a proxy EdgeEnablerNotificationSession
NotFoundException
- no graph found by the given
Id
NullArgumentException
- edgeEnablerReceiver,
graphId
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsEdgeEnablerNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsEdgeEnablerNotification()
and
supportsVisibleFederation()
are true.
EdgeEnablerGraphSession getEdgeEnablerGraphSession(Proxy proxy) throws OperationFailedException
OsidSession
to lookup edge enabler/graph
mappings for edge enablers.proxy
- a proxy EdgeEnablerGraphSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsEdgeEnablerGraph()
is false
optional
- This method must be implemented if
supportsEdgeEnablerGraph()
is true.
EdgeEnablerGraphAssignmentSession getEdgeEnablerGraphAssignmentSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with assigning edge
enablers to ontologies for edge.proxy
- a proxy EdgeEnablerGraphAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsEdgeEnablerGraphAssignment()
is false
optional
- This method must be implemented if
supportsEdgeEnablerGraphAssignment()
is
true.
EdgeEnablerSmartGraphSession getEdgeEnablerSmartGraphSession(Id graphId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
to manage edge enabler smart
ontologies.graphId
- the Id
of the Graph
proxy
- a proxy EdgeEnablerSmartGraphSession
NotFoundException
- no Graph
found by
the given Id
NullArgumentException
- graphId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsEdgeEnablerSmartGraph()
is false
optional
- This method must be implemented if
supportsEdgeEnablerSmartGraph()
is true.
EdgeEnablerRuleLookupSession getEdgeEnablerRuleLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the edge enabler
mapping lookup service for looking up the rules applied to the graph.proxy
- a proxy EdgeEnablerRuleLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsEdgeEnablerRuleLookup()
is false
optional
- This method must be implemented if
supportsEdgeEnablerRuleLookup()
is true.
EdgeEnablerRuleLookupSession getEdgeEnablerRuleLookupSessionForGraph(Id graphId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the edge enabler
mapping lookup service for the given graph for looking up rules
applied to a graph.graphId
- the Id
of the Graph
proxy
- a proxy EdgeEnablerRuleLookupSession
NotFoundException
- no Graph
found by
the given Id
NullArgumentException
- graphId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsEdgeEnablerRuleLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsEdgeEnablerRuleLookup()
and
supportsVisibleFederation()
are true.
EdgeEnablerRuleApplicationSession getEdgeEnablerRuleApplicationSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the edge enabler
assignment service to apply enablers to ontologies.proxy
- a proxy EdgeEnablerRuleApplicationSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsEdgeEnablerRuleApplication()
is false
optional
- This method must be implemented if
supportsEdgeEnablerRuleApplication()
is
true.
EdgeEnablerRuleApplicationSession getEdgeEnablerRuleApplicationSessionForGraph(Id graphId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the edge enabler
assignment service for the given graph to apply enablers to
ontologies.graphId
- the Id
of the Graph
proxy
- a proxy EdgeEnablerRuleApplicationSession
NotFoundException
- no Graph
found by
the given Id
NullArgumentException
- graphId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsEdgeEnablerRuleApplication()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsEdgeEnablerRuleApplication()
and
supportsVisibleFederation()
are true.