org.osid.topology.path

Interface TopologyPathProfile

All Superinterfaces:

OsidProfile, Sourceable

All Known Subinterfaces:

TopologyPathManager, TopologyPathProxyManager

public interface TopologyPathProfile
extends OsidProfile

The topology profile describes the interoperability among topology path services.

Method Summary

Methods

Modifier and Type	Method and Description
TypeList	getPathRecordTypes() Gets the supported Path record types.
TypeList	getPathSearchRecordTypes() Gets the supported Path search types.
boolean	supportsPathAdmin() Tests if path administrative service is supported.
boolean	supportsPathGraph() Tests if a path graph lookup service is supported.
boolean	supportsPathGraphAssignment() Tests if a path graph service is supported.
boolean	supportsPathLookup() Tests if looking up paths is supported.
boolean	supportsPathNotification() Tests if a path notification service is supported.
boolean	supportsPathQuery() Tests if querying paths is supported.
boolean	supportsPathRecordType(Type pathRecordType) Tests if the given Path record type is supported.
boolean	supportsPathSearch() Tests if searching paths is supported.
boolean	supportsPathSearchRecordType(Type pathSearchRecordType) Tests if the given Path search type is supported.
boolean	supportsPathSmartGraph() Tests if a path smart graph lookup service is supported.
boolean	supportsVisibleFederation() Tests if any graph 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 graph federation is exposed. Federation is exposed when a specific graph may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of graphs appears as a single graph.

Returns:

true if visible federation is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsPathLookup

boolean supportsPathLookup()

Tests if looking up paths is supported.

Returns:

true if path lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsPathQuery

boolean supportsPathQuery()

Tests if querying paths is supported.

Returns:

true if path query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsPathSearch

boolean supportsPathSearch()

Tests if searching paths is supported.

Returns:

true if path search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsPathAdmin

boolean supportsPathAdmin()

Tests if path administrative service is supported.

Returns:

true if path administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsPathNotification

boolean supportsPathNotification()

Tests if a path notification service is supported.

Returns:

true if path notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsPathGraph

boolean supportsPathGraph()

Tests if a path graph lookup service is supported.

Returns:

true if a path graph lookup service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsPathGraphAssignment

boolean supportsPathGraphAssignment()

Tests if a path graph service is supported.

Returns:

true if path to graph assignment service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsPathSmartGraph

boolean supportsPathSmartGraph()

Tests if a path smart graph lookup service is supported.

Returns:

true if a path smart graph service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

getPathRecordTypes

TypeList getPathRecordTypes()

Gets the supported Path record types.

Returns:

a list containing the supported Path record types

Compliance:

mandatory - This method must be implemented.

supportsPathRecordType

boolean supportsPathRecordType(Type pathRecordType)

Tests if the given Path record type is supported.

Parameters:

pathRecordType - a Type indicating a Path record type

Returns:

true if the given record type is supported, false otherwise

Throws:

NullArgumentException - pathRecordType is null

Compliance:

mandatory - This method must be implemented.

getPathSearchRecordTypes

TypeList getPathSearchRecordTypes()

Gets the supported Path search types.

Returns:

a list containing the supported Path search types

Compliance:

mandatory - This method must be implemented.

supportsPathSearchRecordType

boolean supportsPathSearchRecordType(Type pathSearchRecordType)

Tests if the given Path search type is supported.

Parameters:

pathSearchRecordType - a Type indicating a Path search type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - pathSearchRecordType is null

Compliance:

mandatory - This method must be implemented.