OSID Logo
OSID Specifications
topology rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.topology.rules.EdgeEnablerSearchSession
Implementsosid.topology.rules.EdgeEnablerQuerySession
Description

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

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

This session defines views that offer differing behaviors for searching.

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

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

MethodgetEdgeEnablerSearch
Description

Gets an edge enabler search.

Returnosid.topology.rules.EdgeEnablerSearchthe edge enabler search
CompliancemandatoryThis method must be implemented.
MethodgetEdgeEnablerSearchOrder
Description

Gets an edge enabler search order. The EdgeEnablerSearchOrder is supplied to an EdgeEnablerSearch to specify the ordering of results.

Returnosid.topology.rules.EdgeEnablerSearchOrderthe edge enabler search order
CompliancemandatoryThis method must be implemented.
MethodgetEdgeEnablersBySearch
Description

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

Parametersosid.topology.rules.EdgeEnablerQueryedgeEnablerQuerythe edge enabler query
osid.topology.rules.EdgeEnablerSearchedgeEnablerSearchthe edge enabler search
Returnosid.topology.rules.EdgeEnablerSearchResultsthe returned search results
ErrorsNULL_ARGUMENT edgeEnablerQuery or edgeEnablerSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED edgeEnablerQuery or edgeEnablerSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetEdgeEnablerQueryFromInspector
Description

Gets an edge enabler query from an inspector. The inspector is available from an EdgeEnablerSearchResults.

Parametersosid.topology.rules.EdgeEnablerQueryInspectoredgeEnablerQueryInspectoran edge enabler query inspector
Returnosid.topology.rules.EdgeEnablerQuerythe edge enabler query
ErrorsNULL_ARGUMENT edgeEnablerQueryInspector is null
UNSUPPORTED edgeEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.