org.osid.topology.rules

Interface TopologyRulesProfile

All Superinterfaces:

OsidProfile, Sourceable

All Known Subinterfaces:

TopologyRulesManager, TopologyRulesProxyManager

public interface TopologyRulesProfile
extends OsidProfile

The topology rules profile describes the interoperability among topology rules services.

Method Summary

Methods

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

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

supportsVisibleFederation

boolean supportsVisibleFederation()

Tests if any broker federation is exposed. Federation is exposed when a specific broker may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of brokers appears as a single broker.

Returns:

true if visible federation is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsEdgeEnablerLookup

boolean supportsEdgeEnablerLookup()

Tests if looking up edge enablers is supported.

Returns:

true if edge enabler lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsEdgeEnablerQuery

boolean supportsEdgeEnablerQuery()

Tests if querying edge enablers is supported.

Returns:

true if edge enabler query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsEdgeEnablerSearch

boolean supportsEdgeEnablerSearch()

Tests if searching edge enablers is supported.

Returns:

true if edge enabler search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsEdgeEnablerAdmin

boolean supportsEdgeEnablerAdmin()

Tests if an edge enabler administrative service is supported.

Returns:

true if edge enabler administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsEdgeEnablerNotification

boolean supportsEdgeEnablerNotification()

Tests if an edge enabler notification service is supported.

Returns:

true if edge enabler notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsEdgeEnablerGraph

boolean supportsEdgeEnablerGraph()

Tests if an edge enabler graph lookup service is supported.

Returns:

true if an edge enabler graph lookup service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsEdgeEnablerGraphAssignment

boolean supportsEdgeEnablerGraphAssignment()

Tests if an edge enabler graph service is supported.

Returns:

true if edge enabler graph assignment service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsEdgeEnablerSmartGraph

boolean supportsEdgeEnablerSmartGraph()

Tests if an edge enabler graph lookup service is supported.

Returns:

true if an edge enabler graph service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsEdgeEnablerRuleLookup

boolean supportsEdgeEnablerRuleLookup()

Tests if an edge enabler rule lookup service is supported.

Returns:

true if an edge enabler rule lookup service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsEdgeEnablerRuleApplication

boolean supportsEdgeEnablerRuleApplication()

Tests if an edge enabler rule application service is supported.

Returns:

true if edge enabler rule application service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

getEdgeEnablerRecordTypes

TypeList getEdgeEnablerRecordTypes()

Gets the supported EdgeEnabler record types.

Returns:

a list containing the supported EdgeEnabler record types

Compliance:

mandatory - This method must be implemented.

supportsEdgeEnablerRecordType

boolean supportsEdgeEnablerRecordType(Type edgeEnablerRecordType)

Tests if the given EdgeEnabler record type is supported.

Parameters:

edgeEnablerRecordType - a Type indicating an EdgeEnabler record type

Returns:

true if the given record type is supported, false otherwise

Throws:

NullArgumentException - edgeEnablerRecordType is null

Compliance:

mandatory - This method must be implemented.

getEdgeEnablerSearchRecordTypes

TypeList getEdgeEnablerSearchRecordTypes()

Gets the supported EdgeEnabler search record types.

Returns:

a list containing the supported EdgeEnabler search record types

Compliance:

mandatory - This method must be implemented.

supportsEdgeEnablerSearchRecordType

boolean supportsEdgeEnablerSearchRecordType(Type edgeEnablerSearchRecordType)

Tests if the given EdgeEnabler search record type is supported.

Parameters:

edgeEnablerSearchRecordType - a Type indicating an EdgeEnabler search record type

Returns:

true if the given search record type is supported, false otherwise

Throws:

NullArgumentException - edgeEnablerSearchRecordType is null

Compliance:

mandatory - This method must be implemented.