OSID Logo
OSID Specifications
mapping path package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.path.IntersectionSearchSession
Implementsosid.mapping.path.IntersectionQuerySession
Description

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

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

This session defines views that offer differing behaviors for searching.

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

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

MethodgetIntersectionSearch
Description

Gets an intersection search.

Returnosid.mapping.path.IntersectionSearchthe intersection search
CompliancemandatoryThis method must be implemented.
MethodgetIntersectionSearchOrder
Description

Gets an intersection search order. The IntersectionSearchOrder is supplied to an IntersectionSearch to specify the ordering of results.

Returnosid.mapping.path.IntersectionSearchOrderthe intersection search order
CompliancemandatoryThis method must be implemented.
MethodgetIntersectionsBySearch
Description

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

Parametersosid.mapping.path.IntersectionQueryintersectionQuerythe intersection query
osid.mapping.path.IntersectionSearchintersectionSearchthe intersection search
Returnosid.mapping.path.IntersectionSearchResultsthe returned search results
ErrorsNULL_ARGUMENT intersectionQuery or intersectionSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED intersectionQuery or intersectionSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetIntersectionQueryFromInspector
Description

Gets an intersection query from an inspector. The inspector is available from an IntersectionSearchResults.

Parametersosid.mapping.path.IntersectionQueryInspectorintersectionQueryInspectoran intersection query inspector
Returnosid.mapping.path.IntersectionQuerythe intersection query
ErrorsNULL_ARGUMENT intersectionQueryInspector is null
UNSUPPORTED intersectionQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.