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

This session manages queries and sequencing to create "smart" dynamic catalogs. An EdgeQuery can be retrieved from this session and mapped to this Graph to create a virtual collection of Edges. The entries may be sequenced using the EdgeSearchOrder from this session.

This Graph has a default query that matches any edge and a default search order that specifies no sequencing. The queries may be examined using an EdgeQueryInspector. The query may be modified by converting the inspector back to an 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.
MethodcanManageSmartGraphs
Description

Tests if this user can manage smart graphs. 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 opt not to offer smart operations.

Returnboolean false if smart graph methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetEdgeQuery
Description

Gets an edge query.

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

Gets an edge search order.

Returnosid.topology.EdgeSearchOrderthe edge search order
CompliancemandatoryThis method must be implemented.
MethodapplyEdgeQuery
Description

Applies an edge query to this graph.

Parametersosid.topology.EdgeQueryedgeQuerythe edge query
ErrorsNULL_ARGUMENT edgeQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED edgeQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectEdgeQuery
Description

Gets an edge query inspector for this graph.

Returnosid.topology.EdgeQueryInspectorthe edge query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyEdgeSequencing
Description

Applies an edge search order to this graph.

Parametersosid.topology.EdgeSearchOrderedgeSearchOrderthe edge search order
ErrorsNULL_ARGUMENT edgeSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED edgeSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetEdgeQueryFromInspector
Description

Gets an edge query from an inspector.

Parametersosid.topology.EdgeQueryInspectoredgeQueryInspectoran edge query inspector
Returnosid.topology.EdgeQuerythe edge query
ErrorsNULL_ARGUMENT relatinshipQueryInspector is null
UNSUPPORTED edgeQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.