OSID Logo
OSID Specifications
mapping path package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.path.IntersectionSmartMapSession
Implementsosid.OsidSession
Description

This session manages queries and sequencing to create "smart" dynamic catalogs. An IntersectionQuery can be retrieved from this session and mapped to this Map to create a virtual collection of Intersections. The intersections may be sequenced using the IntersectionSearchOrder from this session.

This Map has a default query that matches any intersection and a default search order that specifies no sequencing. The queries may be examined using an IntersectionQueryInspector. The query may be modified by converting the inspector back to an IntersectionQuery.

MethodgetMapId
Description

Gets the Map Id associated with this session.

Returnosid.id.Idthe Map Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetMap
Description

Gets the Map associated with this session.

Returnosid.mapping.Mapthe map
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageSmartMaps
Description

Tests if this user can manage smart maps. A return of true does not guarantee successful authorization. A return of false indicates that it is known methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer operations to unauthorized users.

Returnboolean false if smart map management is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetIntersectionQuery
Description

Gets an intersection query.

Returnosid.mapping.path.IntersectionQuerythe intersection query
CompliancemandatoryThis method must be implemented.
MethodgetIntersectionSearchOrder
Description

Gets an intersection search order.

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

Applies an intersection query to this map.

Parametersosid.mapping.path.IntersectionQueryintersectionQuerythe intersection query
ErrorsNULL_ARGUMENT intersectionQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED intersectionQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectIntersectionQuery
Description

Gets an intersection query inspector for this map.

Returnosid.mapping.path.IntersectionQueryInspectorthe intersection query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyIntersectionSequencing
Description

Applies an intersection search order to this map.

Parametersosid.mapping.path.IntersectionSearchOrderintersectionSearchOrderthe intersection search order
ErrorsNULL_ARGUMENT intersectionSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED intersectionsearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetIntersectionQueryFromInspector
Description

Gets an intersection query from an inspector.

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.