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

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

This session defines views that offer differing behaviors for searching.

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

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

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.
MethodcanSearchEdges
Description

Tests if this user can perform Edge 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 edges 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 lookups to this graph only.

CompliancemandatoryThis method is must be implemented.
MethodgetEdgeQuery
Description

Gets an edge query.

Returnosid.topology.EdgeQuerythe edge query
CompliancemandatoryThis method must be implemented.
MethodgetEdgesByQuery
Description

Gets a list of Edges matching the given edge query.

Parametersosid.topology.EdgeQueryedgeQuerythe edge query
Returnosid.topology.EdgeListthe returned EdgeList
ErrorsNULL_ARGUMENT edgeQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED edgeQuery is not of this service
CompliancemandatoryThis method must be implemented.