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

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

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

MethodcanSearchGraphs
Description

Tests if this user can perform Graph searches. 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.
MethodgetGraphQuery
Description

Gets a graph query.

Returnosid.topology.GraphQuerythe graph query
CompliancemandatoryThis method must be implemented.
MethodgetGraphsByQuery
Description

Gets a list of Graphs matching the given graph query.

Parametersosid.topology.GraphQuerygraphQuerythe graph query
Returnosid.topology.GraphListthe returned GraphList
ErrorsNULL_ARGUMENT graphQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED graphQuery is not of this service
CompliancemandatoryThis method must be implemented.