org.osid.topology.rules

Interface TopologyRulesManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidManager, OsidProfile, Sourceable, TopologyRulesProfile

public interface TopologyRulesManager
extends OsidManager, TopologyRulesProfile

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 Summary

Methods

Modifier and Type	Method and Description
EdgeEnablerAdminSession	getEdgeEnablerAdminSession() Gets the OsidSession associated with the edge enabler administration service.
EdgeEnablerAdminSession	getEdgeEnablerAdminSessionForGraph(Id graphId) Gets the OsidSession associated with the edge enabler administration service for the given graph.
EdgeEnablerGraphAssignmentSession	getEdgeEnablerGraphAssignmentSession() Gets the OsidSession associated with assigning edge enablers to ontologies for edge.
EdgeEnablerGraphSession	getEdgeEnablerGraphSession() Gets the OsidSession to lookup edge enabler/graph mappings for edge enablers.
EdgeEnablerLookupSession	getEdgeEnablerLookupSession() Gets the OsidSession associated with the edge enabler lookup service.
EdgeEnablerLookupSession	getEdgeEnablerLookupSessionForGraph(Id graphId) Gets the OsidSession associated with the edge enabler lookup service for the given graph.
EdgeEnablerNotificationSession	getEdgeEnablerNotificationSession(EdgeEnablerReceiver edgeEnablerReceiver) Gets the OsidSession associated with the edge enabler notification service.
EdgeEnablerNotificationSession	getEdgeEnablerNotificationSessionForGraph(EdgeEnablerReceiver edgeEnablerReceiver, Id graphId) Gets the OsidSession associated with the edge enabler notification service for the given graph.
EdgeEnablerQuerySession	getEdgeEnablerQuerySession() Gets the OsidSession associated with the edge enabler query service.
EdgeEnablerQuerySession	getEdgeEnablerQuerySessionForGraph(Id graphId) Gets the OsidSession associated with the edge enabler query service for the given graph.
EdgeEnablerRuleApplicationSession	getEdgeEnablerRuleApplicationSession() Gets the OsidSession associated with the edge enabler assignment service to apply enablers to ontologies.
EdgeEnablerRuleApplicationSession	getEdgeEnablerRuleApplicationSessionForGraph(Id graphId) Gets the OsidSession associated with the edge enabler assignment service for the given graph to apply enablers to ontologies.
EdgeEnablerRuleLookupSession	getEdgeEnablerRuleLookupSession() Gets the OsidSession associated with the edge enabler mapping lookup service for looking up the rules applied to the graph.
EdgeEnablerRuleLookupSession	getEdgeEnablerRuleLookupSessionForGraph(Id graphId) 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() Gets the OsidSession associated with the edge enabler search service.
EdgeEnablerSearchSession	getEdgeEnablerSearchSessionForGraph(Id graphId) Gets the OsidSession associated with the edge enablers earch service for the given graph.
EdgeEnablerSmartGraphSession	getEdgeEnablerSmartGraphSession(Id graphId) Gets the OsidSession to manage edge enabler smart ontologies.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.topology.rules.TopologyRulesProfile

getEdgeEnablerRecordTypes, getEdgeEnablerSearchRecordTypes, supportsEdgeEnablerAdmin, supportsEdgeEnablerGraph, supportsEdgeEnablerGraphAssignment, supportsEdgeEnablerLookup, supportsEdgeEnablerNotification, supportsEdgeEnablerQuery, supportsEdgeEnablerRecordType, supportsEdgeEnablerRuleApplication, supportsEdgeEnablerRuleLookup, supportsEdgeEnablerSearch, supportsEdgeEnablerSearchRecordType, supportsEdgeEnablerSmartGraph, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getEdgeEnablerLookupSession

EdgeEnablerLookupSession getEdgeEnablerLookupSession()
                                                     throws OperationFailedException

Gets the OsidSession associated with the edge enabler lookup service.

Returns:

an EdgeEnablerLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEdgeEnablerLookup() is false

Compliance:

optional - This method must be implemented if supportsEdgeEnablerLookup() is true.

getEdgeEnablerLookupSessionForGraph

EdgeEnablerLookupSession getEdgeEnablerLookupSessionForGraph(Id graphId)
                                                             throws NotFoundException,
                                                                    OperationFailedException

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

Parameters:

graphId - the Id of the Graph

Returns:

an EdgeEnablerLookupSession

Throws:

NotFoundException - no Graph found by the given Id

NullArgumentException - graphId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEdgeEnablerLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsEdgeEnablerLookup() and supportsVisibleFederation() are true.

getEdgeEnablerQuerySession

EdgeEnablerQuerySession getEdgeEnablerQuerySession()
                                                   throws OperationFailedException

Gets the OsidSession associated with the edge enabler query service.

Returns:

an EdgeEnablerQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEdgeEnablerQuery() is false

Compliance:

optional - This method must be implemented if supportsEdgeEnablerQuery() is true.

getEdgeEnablerQuerySessionForGraph

EdgeEnablerQuerySession getEdgeEnablerQuerySessionForGraph(Id graphId)
                                                           throws NotFoundException,
                                                                  OperationFailedException

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

Parameters:

graphId - the Id of the Graph

Returns:

an EdgeEnablerQuerySession

Throws:

NotFoundException - no Graph found by the given Id

NullArgumentException - graphId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEdgeEnablerQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsEdgeEnablerQuery() and supportsVisibleFederation() are true.

getEdgeEnablerSearchSession

EdgeEnablerSearchSession getEdgeEnablerSearchSession()
                                                     throws OperationFailedException

Gets the OsidSession associated with the edge enabler search service.

Returns:

an EdgeEnablerSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEdgeEnablerSearch() is false

Compliance:

optional - This method must be implemented if supportsEdgeEnablerSearch() is true.

getEdgeEnablerSearchSessionForGraph

EdgeEnablerSearchSession getEdgeEnablerSearchSessionForGraph(Id graphId)
                                                             throws NotFoundException,
                                                                    OperationFailedException

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

Parameters:

graphId - the Id of the Graph

Returns:

an EdgeEnablerSearchSession

Throws:

NotFoundException - no Graph found by the given Id

NullArgumentException - graphId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEdgeEnablerSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsEdgeEnablerSearch() and supportsVisibleFederation() are true.

getEdgeEnablerAdminSession

EdgeEnablerAdminSession getEdgeEnablerAdminSession()
                                                   throws OperationFailedException

Gets the OsidSession associated with the edge enabler administration service.

Returns:

an EdgeEnablerAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEdgeEnablerAdmin() is false

Compliance:

optional - This method must be implemented if supportsEdgeEnablerAdmin() is true.

getEdgeEnablerAdminSessionForGraph

EdgeEnablerAdminSession getEdgeEnablerAdminSessionForGraph(Id graphId)
                                                           throws NotFoundException,
                                                                  OperationFailedException

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

Parameters:

graphId - the Id of the Graph

Returns:

an EdgeEnablerAdminSession

Throws:

NotFoundException - no Graph found by the given Id

NullArgumentException - graphId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEdgeEnablerAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsEdgeEnablerAdmin() and supportsVisibleFederation() are true.

getEdgeEnablerNotificationSession

EdgeEnablerNotificationSession getEdgeEnablerNotificationSession(EdgeEnablerReceiver edgeEnablerReceiver)
                                                                 throws OperationFailedException

Gets the OsidSession associated with the edge enabler notification service.

Parameters:

edgeEnablerReceiver - the notification callback

Returns:

an EdgeEnablerNotificationSession

Throws:

NullArgumentException - edgeEnablerReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEdgeEnablerNotification() is false

Compliance:

optional - This method must be implemented if supportsEdgeEnablerNotification() is true.

getEdgeEnablerNotificationSessionForGraph

EdgeEnablerNotificationSession getEdgeEnablerNotificationSessionForGraph(EdgeEnablerReceiver edgeEnablerReceiver,
                                                                       Id graphId)
                                                                         throws NotFoundException,
                                                                                OperationFailedException

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

Parameters:

edgeEnablerReceiver - the notification callback

graphId - the Id of the Graph

Returns:

an EdgeEnablerNotificationSession

Throws:

NotFoundException - no graph found by the given Id

NullArgumentException - edgeEnablerReceiver or graphId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEdgeEnablerNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsEdgeEnablerNotification() and supportsVisibleFederation() are true.

getEdgeEnablerGraphSession

EdgeEnablerGraphSession getEdgeEnablerGraphSession()
                                                   throws OperationFailedException

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

Returns:

an EdgeEnablerGraphSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEdgeEnablerGraph() is false

Compliance:

optional - This method must be implemented if supportsEdgeEnablerGraph() is true.

getEdgeEnablerGraphAssignmentSession

EdgeEnablerGraphAssignmentSession getEdgeEnablerGraphAssignmentSession()
                                                                       throws OperationFailedException

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

Returns:

an EdgeEnablerGraphAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEdgeEnablerGraphAssignment() is false

Compliance:

optional - This method must be implemented if supportsEdgeEnablerGraphAssignment() is true.

getEdgeEnablerSmartGraphSession

EdgeEnablerSmartGraphSession getEdgeEnablerSmartGraphSession(Id graphId)
                                                             throws NotFoundException,
                                                                    OperationFailedException

Gets the OsidSession to manage edge enabler smart ontologies.

Parameters:

graphId - the Id of the Graph

Returns:

an EdgeEnablerSmartGraphSession

Throws:

NotFoundException - no Graph found by the given Id

NullArgumentException - graphId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEdgeEnablerSmartGraph() is false

Compliance:

optional - This method must be implemented if supportsEdgeEnablerSmartGraph() is true.

getEdgeEnablerRuleLookupSession

EdgeEnablerRuleLookupSession getEdgeEnablerRuleLookupSession()
                                                             throws OperationFailedException

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

Returns:

an EdgeEnablerRuleLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEdgeEnablerRuleLookup() is false

Compliance:

optional - This method must be implemented if supportsEdgeEnablerRuleLookup() is true.

getEdgeEnablerRuleLookupSessionForGraph

EdgeEnablerRuleLookupSession getEdgeEnablerRuleLookupSessionForGraph(Id graphId)
                                                                     throws NotFoundException,
                                                                            OperationFailedException

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

Parameters:

graphId - the Id of the Graph

Returns:

an EdgeEnablerRuleLookupSession

Throws:

NotFoundException - no Graph found by the given Id

NullArgumentException - graphId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEdgeEnablerRuleLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsEdgeEnablerRuleLookup() and supportsVisibleFederation() are true.

getEdgeEnablerRuleApplicationSession

EdgeEnablerRuleApplicationSession getEdgeEnablerRuleApplicationSession()
                                                                       throws OperationFailedException

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

Returns:

an EdgeEnablerRuleApplicationSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEdgeEnablerRuleApplication() is false

Compliance:

optional - This method must be implemented if supportsEdgeEnablerRuleApplication() is true.

getEdgeEnablerRuleApplicationSessionForGraph

EdgeEnablerRuleApplicationSession getEdgeEnablerRuleApplicationSessionForGraph(Id graphId)
                                                                               throws NotFoundException,
                                                                                      OperationFailedException

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

Parameters:

graphId - the Id of the Graph

Returns:

an EdgeEnablerRuleApplicationSession

Throws:

NotFoundException - no Graph found by the given Id

NullArgumentException - graphId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEdgeEnablerRuleApplication() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsEdgeEnablerRuleApplication() and supportsVisibleFederation() are true.