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

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

getEdgesByQuery() is the basic search method and returns a list of Edges. A more advanced search may be performed with getEdgesBySearch(). It accepts an EdgeSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getEdgesBySearch() returns an EdgesSearchResults that can be used to access the resulting EdgeList or be used to perform a search within the result set through EdgeSearch.

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.

MethodgetEdgeSearch
Description

Gets an edge search.

Returnosid.topology.EdgeSearchthe edge search
CompliancemandatoryThis method must be implemented.
MethodgetEdgeSearchOrder
Description

Gets an edge search order. The EdgeSearchOrder is supplied to an EdgeSearch to specify the ordering of results.

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

Gets the search results matching the given search query using the given search.

Parametersosid.topology.EdgeQueryedgeQuerythe edge query
osid.topology.EdgeSearchedgeSearchthe edge search
Returnosid.topology.EdgeSearchResultsthe edge search results
ErrorsNULL_ARGUMENT edgeQuery or edgeSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED edgeQuery or edgeSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetEdgeQueryFromInspector
Description

Gets an edge query from an inspector. The inspector is available from an EdgeSearchResults.

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