Interface TopologyRulesManager

All Superinterfaces:

AutoCloseable, Closeable, OsidManager, 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Methods inherited from interface TopologyRulesProfile

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

Modifier and Type	Method	Description
TypeList	getEdgeEnablerRecordTypes()	Gets the supported EdgeEnabler record types.
TypeList	getEdgeEnablerSearchRecordTypes()	Gets the supported EdgeEnabler search record types.
boolean	supportsEdgeEnablerAdmin()	Tests if an edge enabler administrative service is supported.
boolean	supportsEdgeEnablerGraph()	Tests if an edge enabler graph lookup service is supported.
boolean	supportsEdgeEnablerGraphAssignment()	Tests if an edge enabler graph service is supported.
boolean	supportsEdgeEnablerLookup()	Tests if looking up edge enablers is supported.
boolean	supportsEdgeEnablerNotification()	Tests if an edge enabler notification service is supported.
boolean	supportsEdgeEnablerQuery()	Tests if querying edge enablers is supported.
boolean	supportsEdgeEnablerRecordType(Type edgeEnablerRecordType)	Tests if the given EdgeEnabler record type is supported.
boolean	supportsEdgeEnablerRuleApplication()	Tests if an edge enabler rule application service is supported.
boolean	supportsEdgeEnablerRuleLookup()	Tests if an edge enabler rule lookup service is supported.
boolean	supportsEdgeEnablerSearch()	Tests if searching edge enablers is supported.
boolean	supportsEdgeEnablerSearchRecordType(Type edgeEnablerSearchRecordType)	Tests if the given EdgeEnabler search record type is supported.
boolean	supportsEdgeEnablerSmartGraph()	Tests if an edge enabler graph lookup service is supported.
boolean	supportsVisibleFederation()	Tests if any broker federation is exposed.

Method Details

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 {@code supportsEdgeEnablerLookup()} is {@code 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 {@code supportsEdgeEnablerLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsEdgeEnablerQuery()} is {@code 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 {@code supportsEdgeEnablerQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsEdgeEnablerSearch()} is {@code 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 {@code supportsEdgeEnablerSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsEdgeEnablerAdmin()} is {@code 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 {@code supportsEdgeEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsEdgeEnablerNotification()} is {@code 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 {@code supportsEdgeEnablerNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsEdgeEnablerGraph()} is {@code 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 {@code supportsEdgeEnablerGraphAssignment()} is {@code 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 {@code supportsEdgeEnablerSmartGraph()} is {@code 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 {@code supportsEdgeEnablerRuleLookup()} is {@code 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 {@code supportsEdgeEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsEdgeEnablerRuleApplication()} is {@code 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 {@code supportsEdgeEnablerRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .