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

This is the query interface for examining obstacle enabler queries.

MethodgetRuledObstacleIdTerms
Description

Gets the obstacle Id query terms.

Returnosid.search.terms.IdTerm[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetRuledObstacleTerms
Description

Gets the obstacle query terms.

Returnosid.mapping.path.ObstacleQueryInspector[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetMapIdTerms
Description

Gets the map Id query terms.

Returnosid.search.terms.IdTerm[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetMapTerms
Description

Gets the map query terms.

Returnosid.mapping.MapQueryInspector[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetObstacleEnablerQueryInspectorRecord
Description

Gets the obstacle enabler query inspector record corresponding to the given ObstacleEnabler record Type.

Parametersosid.type.TypeobstacleEnablerRecordTypean obstacle enabler record type
Returnosid.mapping.path.rules.records.ObstacleEnablerQueryInspectorRecordthe obstacle enabler query inspector record
ErrorsNULL_ARGUMENT obstacleEnablerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(obstacleEnablerRecordType) is false
CompliancemandatoryThis method must be implemented.