OSID Logo
OSID Specifications
mapping path package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.path.ObstacleSearchSession
Implementsosid.mapping.path.ObstacleQuerySession
Description

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

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

This session defines views that offer differing behaviors for searching.

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

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

MethodgetObstacleSearch
Description

Gets an obstacle search.

Returnosid.mapping.path.ObstacleSearchthe obstacle search
CompliancemandatoryThis method must be implemented.
MethodgetObstacleSearchOrder
Description

Gets an obstacle search order. The ObstacleSearchOrder is supplied to an ObstacleSearch to specify the ordering of results.

Returnosid.mapping.path.ObstacleSearchOrderthe obstacle search order
CompliancemandatoryThis method must be implemented.
MethodgetObstaclesBySearch
Description

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

Parametersosid.mapping.path.ObstacleQueryobstacleQuerythe obstacle query
osid.mapping.path.ObstacleSearchobstacleSearchthe obstacle search
Returnosid.mapping.path.ObstacleSearchResultsthe returned search results
ErrorsNULL_ARGUMENT obstacleQuery or obstacleSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED obstacleQuery or obstacleSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetObstacleQueryFromInspector
Description

Gets an obstacle query from an inspector. The inspector is available from an ObstacleSearchResults.

Parametersosid.mapping.path.ObstacleQueryInspectorobstacleQueryInspectoran obstacle query inspector
Returnosid.mapping.path.ObstacleQuerythe obstacle query
ErrorsNULL_ARGUMENT obstacleQueryInspector is null
UNSUPPORTED obstacleQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.