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

This session manages queries and sequencing to create "smart" dynamic catalogs. A PathQuery can be retrieved from this session and mapped to this Map to create a virtual collection of Paths. The paths may be sequenced using the PathSearchOrder from this session.

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

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.
MethodgetPathQuery
Description

Gets a path query.

Returnosid.mapping.path.PathQuerythe path query
CompliancemandatoryThis method must be implemented.
MethodgetPathSearchOrder
Description

Gets a path search order.

Returnosid.mapping.path.PathSearchOrderthe path search order
CompliancemandatoryThis method must be implemented.
MethodapplyPathQuery
Description

Applies a path query to this map.

Parametersosid.mapping.path.PathQuerypathQuerythe path query
ErrorsNULL_ARGUMENT pathQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED pathQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectPathQuery
Description

Gets a path query inspector for this map.

Returnosid.mapping.path.PathQueryInspectorthe path query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyPathSequencing
Description

Applies a path search order to this map.

Parametersosid.mapping.path.PathSearchOrderpathSearchOrderthe path search order
ErrorsNULL_ARGUMENT pathSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED pathSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetPathQueryFromInspector
Description

Gets a path query from an inspector.

Parametersosid.mapping.path.PathQueryInspectorpathQueryInspectora path query inspector
Returnosid.mapping.path.PathQuerythe path query
ErrorsNULL_ARGUMENT pathQueryInspector is null
UNSUPPORTED pathQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.