org.osid.mapping.path.rules

Interface MappingPathRulesProfile

All Superinterfaces:

OsidProfile, Sourceable

All Known Subinterfaces:

MappingPathRulesManager, MappingPathRulesProxyManager

public interface MappingPathRulesProfile
extends OsidProfile

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

Method Summary

Methods

Modifier and Type	Method and Description
TypeList	getObstacleEnablerRecordTypes() Gets the supported ObstacleEnabler record types.
TypeList	getObstacleEnablerSearchRecordTypes() Gets the supported ObstacleEnabler search record types.
TypeList	getSignalEnablerRecordTypes() Gets the supported SignalEnabler record types.
TypeList	getSignalEnablerSearchRecordTypes() Gets the supported SignalEnabler search record types.
TypeList	getSpeedZoneEnablerRecordTypes() Gets the supported SpeedZoneEnabler record types.
TypeList	getSpeedZoneEnablerSearchRecordTypes() Gets the supported SpeedZoneEnabler search record types.
boolean	supportsObstacleEnablerAdmin() Tests if an obstacle enabler administrative service is supported.
boolean	supportsObstacleEnablerLookup() Tests if looking up obstacle enabler is supported.
boolean	supportsObstacleEnablerMap() Tests if an obstacle enabler map lookup service is supported.
boolean	supportsObstacleEnablerMapAssignment() Tests if an obstacle enabler map service is supported.
boolean	supportsObstacleEnablerNotification() Tests if an obstacle enabler notification service is supported.
boolean	supportsObstacleEnablerQuery() Tests if querying obstacle enabler is supported.
boolean	supportsObstacleEnablerRecordType(Type obstacleEnablerRecordType) Tests if the given ObstacleEnabler record type is supported.
boolean	supportsObstacleEnablerRuleApplication() Tests if an obstacle enabler rule application service is supported.
boolean	supportsObstacleEnablerRuleLookup() Tests if an obstacle enabler rule lookup service is supported.
boolean	supportsObstacleEnablerSearch() Tests if searching obstacle enabler is supported.
boolean	supportsObstacleEnablerSearchRecordType(Type obstacleEnablerSearchRecordType) Tests if the given ObstacleEnabler search record type is supported.
boolean	supportsObstacleEnablerSmartMap() Tests if an obstacle enabler map lookup service is supported.
boolean	supportsSignalEnablerAdmin() Tests if a signal enabler administrative service is supported.
boolean	supportsSignalEnablerLookup() Tests if looking up signal enabler is supported.
boolean	supportsSignalEnablerMap() Tests if a signal enabler map lookup service is supported.
boolean	supportsSignalEnablerMapAssignment() Tests if a signal enabler map service is supported.
boolean	supportsSignalEnablerNotification() Tests if a signal enabler notification service is supported.
boolean	supportsSignalEnablerQuery() Tests if querying signal enabler is supported.
boolean	supportsSignalEnablerRecordType(Type signalEnablerRecordType) Tests if the given SignalEnabler record type is supported.
boolean	supportsSignalEnablerRuleApplication() Tests if a signal enabler rule application service is supported.
boolean	supportsSignalEnablerRuleLookup() Tests if a signal enabler rule lookup service is supported.
boolean	supportsSignalEnablerSearch() Tests if searching signal enabler is supported.
boolean	supportsSignalEnablerSearchRecordType(Type signalEnablerSearchRecordType) Tests if the given SignalEnabler search record type is supported.
boolean	supportsSignalEnablerSmartMap() Tests if a signal enabler map lookup service is supported.
boolean	supportsSpeedZoneEnablerAdmin() Tests if a speed zone enabler administrative service is supported.
boolean	supportsSpeedZoneEnablerLookup() Tests if looking up speed zone enablers is supported.
boolean	supportsSpeedZoneEnablerMap() Tests if a speed zone enabler map lookup service is supported.
boolean	supportsSpeedZoneEnablerMapAssignment() Tests if a speed zone enabler map service is supported.
boolean	supportsSpeedZoneEnablerNotification() Tests if a speed zone enabler notification service is supported.
boolean	supportsSpeedZoneEnablerQuery() Tests if querying speed zone enablers is supported.
boolean	supportsSpeedZoneEnablerRecordType(Type speedZoneEnablerRecordType) Tests if the given SpeedZoneEnabler record type is supported.
boolean	supportsSpeedZoneEnablerRuleApplication() Tests if a speed zone enabler rule application service is supported.
boolean	supportsSpeedZoneEnablerRuleLookup() Tests if a speed zone enabler rule lookup service is supported.
boolean	supportsSpeedZoneEnablerSearch() Tests if searching speed zone enablers is supported.
boolean	supportsSpeedZoneEnablerSearchRecordType(Type speedZoneEnablerSearchRecordType) Tests if the given SpeedZoneEnabler search record type is supported.
boolean	supportsSpeedZoneEnablerSmartMap() Tests if a speed zone enabler map 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.

supportsSpeedZoneEnablerLookup

boolean supportsSpeedZoneEnablerLookup()

Tests if looking up speed zone enablers is supported.

Returns:

true if speed zone enabler lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsSpeedZoneEnablerQuery

boolean supportsSpeedZoneEnablerQuery()

Tests if querying speed zone enablers is supported.

Returns:

true if speed zone enabler query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsSpeedZoneEnablerSearch

boolean supportsSpeedZoneEnablerSearch()

Tests if searching speed zone enablers is supported.

Returns:

true if speed zone enabler search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsSpeedZoneEnablerAdmin

boolean supportsSpeedZoneEnablerAdmin()

Tests if a speed zone enabler administrative service is supported.

Returns:

true if speed zone enabler administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsSpeedZoneEnablerNotification

boolean supportsSpeedZoneEnablerNotification()

Tests if a speed zone enabler notification service is supported.

Returns:

true if speed zone enabler notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsSpeedZoneEnablerMap

boolean supportsSpeedZoneEnablerMap()

Tests if a speed zone enabler map lookup service is supported.

Returns:

true if a speed zone enabler map lookup service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsSpeedZoneEnablerMapAssignment

boolean supportsSpeedZoneEnablerMapAssignment()

Tests if a speed zone enabler map service is supported.

Returns:

true if speed zone enabler map assignment service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsSpeedZoneEnablerSmartMap

boolean supportsSpeedZoneEnablerSmartMap()

Tests if a speed zone enabler map lookup service is supported.

Returns:

true if a speed zone enabler map service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsSpeedZoneEnablerRuleLookup

boolean supportsSpeedZoneEnablerRuleLookup()

Tests if a speed zone enabler rule lookup service is supported.

Returns:

true if a speed zone enabler rule lookup service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsSpeedZoneEnablerRuleApplication

boolean supportsSpeedZoneEnablerRuleApplication()

Tests if a speed zone enabler rule application service is supported.

Returns:

true if speed zone enabler rule application service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsSignalEnablerLookup

boolean supportsSignalEnablerLookup()

Tests if looking up signal enabler is supported.

Returns:

true if signal enabler lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsSignalEnablerQuery

boolean supportsSignalEnablerQuery()

Tests if querying signal enabler is supported.

Returns:

true if signal enabler query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsSignalEnablerSearch

boolean supportsSignalEnablerSearch()

Tests if searching signal enabler is supported.

Returns:

true if signal enabler search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsSignalEnablerAdmin

boolean supportsSignalEnablerAdmin()

Tests if a signal enabler administrative service is supported.

Returns:

true if signal enabler administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsSignalEnablerNotification

boolean supportsSignalEnablerNotification()

Tests if a signal enabler notification service is supported.

Returns:

true if signal enabler notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsSignalEnablerMap

boolean supportsSignalEnablerMap()

Tests if a signal enabler map lookup service is supported.

Returns:

true if a signal enabler map lookup service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsSignalEnablerMapAssignment

boolean supportsSignalEnablerMapAssignment()

Tests if a signal enabler map service is supported.

Returns:

true if signal enabler map assignment service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsSignalEnablerSmartMap

boolean supportsSignalEnablerSmartMap()

Tests if a signal enabler map lookup service is supported.

Returns:

true if a signal enabler map service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsSignalEnablerRuleLookup

boolean supportsSignalEnablerRuleLookup()

Tests if a signal enabler rule lookup service is supported.

Returns:

true if a signal enabler rule lookup service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsSignalEnablerRuleApplication

boolean supportsSignalEnablerRuleApplication()

Tests if a signal enabler rule application service is supported.

Returns:

true if a signal enabler rule application service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsObstacleEnablerLookup

boolean supportsObstacleEnablerLookup()

Tests if looking up obstacle enabler is supported.

Returns:

true if obstacle enabler lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsObstacleEnablerQuery

boolean supportsObstacleEnablerQuery()

Tests if querying obstacle enabler is supported.

Returns:

true if obstacle enabler query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsObstacleEnablerSearch

boolean supportsObstacleEnablerSearch()

Tests if searching obstacle enabler is supported.

Returns:

true if obstacle enabler search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsObstacleEnablerAdmin

boolean supportsObstacleEnablerAdmin()

Tests if an obstacle enabler administrative service is supported.

Returns:

true if obstacle enabler administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsObstacleEnablerNotification

boolean supportsObstacleEnablerNotification()

Tests if an obstacle enabler notification service is supported.

Returns:

true if obstacle enabler notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsObstacleEnablerMap

boolean supportsObstacleEnablerMap()

Tests if an obstacle enabler map lookup service is supported.

Returns:

true if an obstacle enabler map lookup service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsObstacleEnablerMapAssignment

boolean supportsObstacleEnablerMapAssignment()

Tests if an obstacle enabler map service is supported.

Returns:

true if obstacle enabler map assignment service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsObstacleEnablerSmartMap

boolean supportsObstacleEnablerSmartMap()

Tests if an obstacle enabler map lookup service is supported.

Returns:

true if an obstacle enabler map service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsObstacleEnablerRuleLookup

boolean supportsObstacleEnablerRuleLookup()

Tests if an obstacle enabler rule lookup service is supported.

Returns:

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

Compliance:

mandatory - This method must be implemented.

supportsObstacleEnablerRuleApplication

boolean supportsObstacleEnablerRuleApplication()

Tests if an obstacle enabler rule application service is supported.

Returns:

true if an obstacle enabler rule application service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

getSpeedZoneEnablerRecordTypes

TypeList getSpeedZoneEnablerRecordTypes()

Gets the supported SpeedZoneEnabler record types.

Returns:

a list containing the supported SpeedZoneEnabler record types

Compliance:

mandatory - This method must be implemented.

supportsSpeedZoneEnablerRecordType

boolean supportsSpeedZoneEnablerRecordType(Type speedZoneEnablerRecordType)

Tests if the given SpeedZoneEnabler record type is supported.

Parameters:

speedZoneEnablerRecordType - a Type indicating a SpeedZoneEnabler record type

Returns:

true if the given record type is supported, false otherwise

Throws:

NullArgumentException - speedZoneEnablerRecordType is null

Compliance:

mandatory - This method must be implemented.

getSpeedZoneEnablerSearchRecordTypes

TypeList getSpeedZoneEnablerSearchRecordTypes()

Gets the supported SpeedZoneEnabler search record types.

Returns:

a list containing the supported SpeedZoneEnabler search record types

Compliance:

mandatory - This method must be implemented.

supportsSpeedZoneEnablerSearchRecordType

boolean supportsSpeedZoneEnablerSearchRecordType(Type speedZoneEnablerSearchRecordType)

Tests if the given SpeedZoneEnabler search record type is supported.

Parameters:

speedZoneEnablerSearchRecordType - a Type indicating a SpeedZoneEnabler search record type

Returns:

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

Throws:

NullArgumentException - speedZoneEnablerSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getSignalEnablerRecordTypes

TypeList getSignalEnablerRecordTypes()

Gets the supported SignalEnabler record types.

Returns:

a list containing the supported SignalEnabler record types

Compliance:

mandatory - This method must be implemented.

supportsSignalEnablerRecordType

boolean supportsSignalEnablerRecordType(Type signalEnablerRecordType)

Tests if the given SignalEnabler record type is supported.

Parameters:

signalEnablerRecordType - a Type indicating a SignalEnabler record type

Returns:

true if the given record type is supported, false otherwise

Throws:

NullArgumentException - signalEnablerRecordType is null

Compliance:

mandatory - This method must be implemented.

getSignalEnablerSearchRecordTypes

TypeList getSignalEnablerSearchRecordTypes()

Gets the supported SignalEnabler search record types.

Returns:

a list containing the supported SignalEnabler search record types

Compliance:

mandatory - This method must be implemented.

supportsSignalEnablerSearchRecordType

boolean supportsSignalEnablerSearchRecordType(Type signalEnablerSearchRecordType)

Tests if the given SignalEnabler search record type is supported.

Parameters:

signalEnablerSearchRecordType - a Type indicating a SignalEnabler search record type

Returns:

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

Throws:

NullArgumentException - signalEnablerSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getObstacleEnablerRecordTypes

TypeList getObstacleEnablerRecordTypes()

Gets the supported ObstacleEnabler record types.

Returns:

a list containing the supported ObstacleEnabler record types

Compliance:

mandatory - This method must be implemented.

supportsObstacleEnablerRecordType

boolean supportsObstacleEnablerRecordType(Type obstacleEnablerRecordType)

Tests if the given ObstacleEnabler record type is supported.

Parameters:

obstacleEnablerRecordType - a Type indicating an ObstacleEnabler record type

Returns:

true if the given record type is supported, false otherwise

Throws:

NullArgumentException - obstacleEnablerRecordType is null

Compliance:

mandatory - This method must be implemented.

getObstacleEnablerSearchRecordTypes

TypeList getObstacleEnablerSearchRecordTypes()

Gets the supported ObstacleEnabler search record types.

Returns:

a list containing the supported ObstacleEnabler search record types

Compliance:

mandatory - This method must be implemented.

supportsObstacleEnablerSearchRecordType

boolean supportsObstacleEnablerSearchRecordType(Type obstacleEnablerSearchRecordType)

Tests if the given ObstacleEnabler search record type is supported.

Parameters:

obstacleEnablerSearchRecordType - a Type indicating an ObstacleEnabler search record type

Returns:

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

Throws:

NullArgumentException - obstacleEnablerSearchRecordType is null

Compliance:

mandatory - This method must be implemented.