Interface TopologyPathManager

All Superinterfaces:

AutoCloseable, Closeable, OsidManager, OsidManager, OsidProfile, Sourceable, TopologyPathProfile

public interface TopologyPathManager
extends OsidManager, TopologyPathProfile

The topology manager provides access to topology path sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

• PathLookupSession : a session to retrieve paths
• PathQuerySession : a session to query for paths
• PathSearchSession : a session to search for paths
• PathAdminSession : a session to create and delete paths
• PathNotificationSession : a session to receive notifications pertaining to path changes
• PathMapSession : a session to looking locations of paths to maps
• PathMapAssignmentSession : a session to manage path to graph mappings
• PathMapAssignmentSession : a session to manage dynamic graphs of paths

Method Summary

Modifier and Type	Method	Description
PathAdminSession	getPathAdminSession()	Gets the OsidSession associated with the path administration service.
PathAdminSession	getPathAdminSessionForGraph(Id graphId)	Gets the OsidSession associated with the path administration service for the given graph.
PathGraphAssignmentSession	getPathGraphAssignmentSession()	Gets the OsidSession associated with assigning paths to graphs.
PathGraphSession	getPathGraphSession()	Gets the OsidSession to lookup path/graph locations.
PathLookupSession	getPathLookupSession()	Gets the OsidSession associated with the path lookup service.
PathLookupSession	getPathLookupSessionForGraph(Id graphId)	Gets the OsidSession associated with the path lookup service for the given graph.
PathNotificationSession	getPathNotificationSession(PathReceiver pathReceiver)	Gets the OsidSession associated with the path notification service.
PathNotificationSession	getPathNotificationSessionForGraph(PathReceiver pathReceiver, Id graphId)	Gets the OsidSession associated with the path notification service for the given graph.
PathQuerySession	getPathQuerySession()	Gets the OsidSession associated with the path query service.
PathQuerySession	getPathQuerySessionForGraph(Id graphId)	Gets the OsidSession associated with the path query service for the given graph.
PathSearchSession	getPathSearchSession()	Gets the OsidSession associated with the path search service.
PathSearchSession	getPathSearchSessionForGraph(Id graphId)	Gets the OsidSession associated with the path search service for the given graph.
PathSmartGraphSession	getPathSmartGraphSession(Id graphId)	Gets the OsidSession to manage path smart graphs.

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 TopologyPathProfile

getPathRecordTypes, getPathSearchRecordTypes, supportsPathAdmin, supportsPathGraph, supportsPathGraphAssignment, supportsPathLookup, supportsPathNotification, supportsPathQuery, supportsPathRecordType, supportsPathSearch, supportsPathSearchRecordType, supportsPathSmartGraph, supportsVisibleFederation

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

Method Details

getPathLookupSession

PathLookupSession getPathLookupSession()
                                throws OperationFailedException

Gets the OsidSession associated with the path lookup service.

Returns:

a PathLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPathLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsPathLookup()} is {@code true} .

getPathLookupSessionForGraph

PathLookupSession getPathLookupSessionForGraph(Id graphId)
                                        throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the path lookup service for the given graph.

Parameters:

graphId - the Id of the Graph

Returns:

a PathLookupSession

Throws:

NotFoundException - no Graph found by the given Id

NullArgumentException - graphId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPathLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsPathLookup()} and {@code supportsVisibleFederation()} are {@code true}

getPathQuerySession

PathQuerySession getPathQuerySession()
                              throws OperationFailedException

Gets the OsidSession associated with the path query service.

Returns:

a PathQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPathQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsPathQuery()} is {@code true} .

getPathQuerySessionForGraph

PathQuerySession getPathQuerySessionForGraph(Id graphId)
                                      throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the path query service for the given graph.

Parameters:

graphId - the Id of the Graph

Returns:

a PathQuerySession

Throws:

NotFoundException - no graph found by the given Id

NullArgumentException - graphId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPathQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsPathQuery()} and {@code supportsVisibleFederation()} are {@code true}

getPathSearchSession

PathSearchSession getPathSearchSession()
                                throws OperationFailedException

Gets the OsidSession associated with the path search service.

Returns:

a PathSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPathSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsPathSearch()} is {@code true} .

getPathSearchSessionForGraph

PathSearchSession getPathSearchSessionForGraph(Id graphId)
                                        throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the path search service for the given graph.

Parameters:

graphId - the Id of the Graph

Returns:

a PathSearchSession

Throws:

NotFoundException - no graph found by the given Id

NullArgumentException - graphId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPathSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsPathSearch()} and {@code supportsVisibleFederation()} are {@code true}

getPathAdminSession

PathAdminSession getPathAdminSession()
                              throws OperationFailedException

Gets the OsidSession associated with the path administration service.

Returns:

a PathAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPathAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsPathAdmin()} is {@code true} .

getPathAdminSessionForGraph

PathAdminSession getPathAdminSessionForGraph(Id graphId)
                                      throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the path administration service for the given graph.

Parameters:

graphId - the Id of the graph

Returns:

a PathAdminSession

Throws:

NotFoundException - no graph found by the given Id

NullArgumentException - graphId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPathAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsPathAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getPathNotificationSession

PathNotificationSession getPathNotificationSession(PathReceiver pathReceiver)
                                            throws OperationFailedException

Gets the OsidSession associated with the path notification service.

Parameters:

pathReceiver - the notification callback

Returns:

a PathNotificationSession

Throws:

NullArgumentException - pathReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPathNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsPathNotification()} is {@code true} .

getPathNotificationSessionForGraph

PathNotificationSession getPathNotificationSessionForGraph(PathReceiver pathReceiver,
 Id graphId)
                                                    throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the path notification service for the given graph.

Parameters:

pathReceiver - the notification callback

graphId - the Id of the Graph

Returns:

a PathNotificationSession

Throws:

NotFoundException - no graph found by the given Id

NullArgumentException - pathReceiver or graphId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPathNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsPathNotification()} and {@code supportsVisibleFederation()} are {@code true}

getPathGraphSession

PathGraphSession getPathGraphSession()
                              throws OperationFailedException

Gets the OsidSession to lookup path/graph locations.

Returns:

a PathGraphSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPathGraph() is false

Compliance:

optional - This method must be implemented if {@code supportsPathGraph()} is {@code true} .

getPathGraphAssignmentSession

PathGraphAssignmentSession getPathGraphAssignmentSession()
                                                  throws OperationFailedException

Gets the OsidSession associated with assigning paths to graphs.

Returns:

a PathGraphAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPathGraphAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsPathGraphAssignment()} is {@code true} .

getPathSmartGraphSession

PathSmartGraphSession getPathSmartGraphSession(Id graphId)
                                        throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage path smart graphs.

Parameters:

graphId - the Id of the Graph

Returns:

a PathSmartGraphSession

Throws:

NotFoundException - no graph found by the given Id

NullArgumentException - pathReceiver or graphId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPathSmartGraph() is false

Compliance:

optional - This method must be implemented if {@code supportsPathSmartGraph()} is {@code true} .