org.osid.topology.path

Interface TopologyPathProxyManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidProfile, OsidProxyManager, Sourceable, TopologyPathProfile

public interface TopologyPathProxyManager
extends OsidProxyManager, TopologyPathProfile

The topology manager provides access to topology path sessions and provides interoperability tests for various aspects of this service. Methods in this manager include a Proxy for passing information from server environments.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

Methods

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

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidProxyManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.topology.path.TopologyPathProfile

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

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

getPathLookupSession

PathLookupSession getPathLookupSession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the path lookup service.

Parameters:

proxy - a proxy

Returns:

a PathLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPathLookup() is false

Compliance:

optional - This method must be implemented if supportsPathLookup() is true.

getPathLookupSessionForGraph

PathLookupSession getPathLookupSessionForGraph(Id graphId,
                                             Proxy proxy)
                                               throws NotFoundException,
                                                      OperationFailedException

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

Parameters:

graphId - the Id of the Graph

proxy - a proxy

Returns:

a PathLookupSession

Throws:

NotFoundException - no graph found by the given Id

NullArgumentException - graphId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPathLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPathLookup() and supportsVisibleFederation() are true

getPathQuerySession

PathQuerySession getPathQuerySession(Proxy proxy)
                                     throws OperationFailedException

Gets the OsidSession associated with the path query service.

Parameters:

proxy - a proxy

Returns:

a PathQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPathQuery() is false

Compliance:

optional - This method must be implemented if supportsPathQuery() is true.

getPathQuerySessionForGraph

PathQuerySession getPathQuerySessionForGraph(Id graphId,
                                           Proxy proxy)
                                             throws NotFoundException,
                                                    OperationFailedException

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

Parameters:

graphId - the Id of the Graph

proxy - a proxy

Returns:

a PathQuerySession

Throws:

NotFoundException - no graph found by the given Id

NullArgumentException - graphId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPathQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPathQuery() and supportsVisibleFederation() are true

getPathSearchSession

PathSearchSession getPathSearchSession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the path search service.

Parameters:

proxy - a proxy

Returns:

a PathSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPathSearch() is false

Compliance:

optional - This method must be implemented if supportsPathSearch() is true.

getPathSearchSessionForGraph

PathSearchSession getPathSearchSessionForGraph(Id graphId,
                                             Proxy proxy)
                                               throws NotFoundException,
                                                      OperationFailedException

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

Parameters:

graphId - the Id of the Graph

proxy - a proxy

Returns:

a PathSearchSession

Throws:

NotFoundException - no graph found by the given Id

NullArgumentException - graphId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPathSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPathSearch() and supportsVisibleFederation() are true

getPathAdminSession

PathAdminSession getPathAdminSession(Proxy proxy)
                                     throws OperationFailedException

Gets the OsidSession associated with the path administration service.

Parameters:

proxy - a proxy

Returns:

a PathAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPathAdmin() is false

Compliance:

optional - This method must be implemented if supportsPathAdmin() is true.

getPathAdminSessionForGraph

PathAdminSession getPathAdminSessionForGraph(Id graphId,
                                           Proxy proxy)
                                             throws NotFoundException,
                                                    OperationFailedException

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

Parameters:

graphId - the Id of the Graph

proxy - a proxy

Returns:

a PathAdminSession

Throws:

NotFoundException - no graph found by the given Id

NullArgumentException - graphId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPathAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPathAdmin() and supportsVisibleFederation() are true

getPathNotificationSession

PathNotificationSession getPathNotificationSession(PathReceiver pathReceiver,
                                                 Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the path notification service.

Parameters:

pathReceiver - the notification callback

proxy - a proxy

Returns:

a PathNotificationSession

Throws:

NullArgumentException - pathReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPathNotification() is false

Compliance:

optional - This method must be implemented if supportsPathNotification() is true.

getPathNotificationSessionForGraph

PathNotificationSession getPathNotificationSessionForGraph(PathReceiver pathReceiver,
                                                         Id graphId,
                                                         Proxy proxy)
                                                           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

proxy - a proxy

Returns:

a PathNotificationSession

Throws:

NotFoundException - no graph found by the given Id

NullArgumentException - pathReceiver, graphId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPathNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPathNotification() and supportsVisibleFederation() are true

getPathGraphSession

PathGraphSession getPathGraphSession(Proxy proxy)
                                     throws OperationFailedException

Gets the OsidSession to lookup path/graph mappings.

Parameters:

proxy - a proxy

Returns:

a PathGraphSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPathGraph() is false

Compliance:

optional - This method must be implemented if supportsPathGraph() is true.

getPathGraphAssignmentSession

PathGraphAssignmentSession getPathGraphAssignmentSession(Proxy proxy)
                                                         throws OperationFailedException

Gets the OsidSession associated with assigning paths to maps.

Parameters:

proxy - a proxy

Returns:

a PathGraphAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPathGraphAssignment() is false

Compliance:

optional - This method must be implemented if supportsPathGraphAssignment() is true.

getPathSmartGraphSession

PathSmartGraphSession getPathSmartGraphSession(Id graphId,
                                             Proxy proxy)
                                               throws NotFoundException,
                                                      OperationFailedException

Gets the OsidSession to manage path smart graphs.

Parameters:

graphId - the Id of the Graph

proxy - a proxy

Returns:

a PathSmartMGraphSession

Throws:

NotFoundException - no graph found by the given Id

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPathSmartGraph() is false

Compliance:

optional - This method must be implemented if supportsPathSmartGraph() is true.