OSID Logo
OSID Specifications
topology path package
Version 3.0.0
Release Candidate Preview
Interfaceosid.topology.path.PathQuerySession
Implementsosid.OsidSession
Description

This session provides methods for searching among Path objects. The search query is constructed using the PathQuery.

This session defines views that offer differing behaviors for searching.

  • federated graph view: searches include paths in graphs of which this graph is an ancestor in the graph hierarchy
  • isolated graph view: searches are restricted to paths in this graph

Paths may have a query record indicated by their respective record types. The query record is accessed via the PathQuery.

MethodgetGraphId
Description

Gets the Graph Id associated with this session.

Returnosid.id.Idthe Graph Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetGraph
Description

Gets the Graph associated with this session.

Returnosid.topology.Graphthe graph
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSearchPaths
Description

Tests if this user can perform Path lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.

Returnboolean false if search methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedGraphView
Description

Federates the view for methods in this session. A federated view will include paths in graphs which are children of this graph in the graph hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedGraphView
Description

Isolates the view for methods in this session. An isolated view restricts searches to this graph only.

CompliancemandatoryThis method is must be implemented.
MethodgetPathQuery
Description

Gets a path query.

Returnosid.topology.path.PathQuerythe path query
CompliancemandatoryThis method must be implemented.
MethodgetPathsByQuery
Description

Gets a list of Paths matching the given path query.

Parametersosid.topology.path.PathQuerypathQuerythe path query
Returnosid.topology.path.PathListthe returned PathList
ErrorsNULL_ARGUMENT pathQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED pathQuery is not of this service
CompliancemandatoryThis method must be implemented.