OSID Logo
OSID Specifications
mapping path rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.path.rules.ObstacleEnablerSearchSession
Implementsosid.mapping.path.rules.ObstacleEnablerQuerySession
Description

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

getObstacleEnablersByQuery() is the basic search method and returns a list of ObstacleEnablers. A more advanced search may be performed with getObstacleEnablersBySearch(). It accepts an ObstacleEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as mapping. getObstacleEnablersBySearch() returns an ObstacleEnablerSearchResults that can be used to access the resulting ObstacleEnablerList or be used to perform a search within the result set through ObstacleEnablerSearch.

This session defines views that offer differing behaviors for searching.

  • federated map view: searches include obstacle enabler in map of which this map matchmaker is an ancestor in the map hierarchy
  • isolated map view: searches are restricted to obstacle enabler in this office

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

MethodgetObstacleEnablerSearch
Description

Gets an obstacle enabler search.

Returnosid.mapping.path.rules.ObstacleEnablerSearchthe obstacle enabler search
CompliancemandatoryThis method must be implemented.
MethodgetObstacleEnablerSearchOrder
Description

Gets an obstacle enabler search order. The ObstacleEnablerSearchOrder is supplied to an ObstacleEnablerSearch to specify the ordering of results.

Returnosid.mapping.path.rules.ObstacleEnablerSearchOrderthe obstacle enabler search order
CompliancemandatoryThis method must be implemented.
MethodgetObstacleEnablersBySearch
Description

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

Parametersosid.mapping.path.rules.ObstacleEnablerQueryobstacleEnablerQuerythe obstacle enabler query
osid.mapping.path.rules.ObstacleEnablerSearchobstacleEnablerSearchthe obstacle enabler search
Returnosid.mapping.path.rules.ObstacleEnablerSearchResultsthe returned search results
ErrorsNULL_ARGUMENT obstacleEnablerQuery or obstacleEnablerSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED obstacleEnablerQuery or obstacleEnablerSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetObstacleEnablerQueryFromInspector
Description

Gets an obstacle enabler query from an inspector. The inspector is available from an ObstacleEnablerSearchResults.

Parametersosid.mapping.path.rules.ObstacleEnablerQueryInspectorobstacleEnablerQueryInspectoran obstacle enabler query inspector
Returnosid.mapping.path.rules.ObstacleEnablerQuerythe obstacle enabler query
ErrorsNULL_ARGUMENT obstacleEnablerQueryInspector is null
UNSUPPORTED obstacleEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.