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

This is the query for searching obstacle enablers. Each method match specifies an AND term while multiple invocations of the same method produce a nested OR.

MethodmatchRuledObstacleId
Description

Matches enablers mapped to an obstacle.

Parametersosid.id.IdobstacleIdthe obstacle Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT obstacleId is null
CompliancemandatoryThis method must be implemented.
MethodclearRuledObstacleIdTerms
Description

Clears the obstacle Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRuledObstacleQuery
Description

Tests if an ObstacleQuery is available.

Returnboolean true if an obstacle query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetRuledObstacleQuery
Description

Gets the query for an obstacle. Multiple retrievals produce a nested OR term.

Returnosid.mapping.path.ObstacleQuerythe obstacle query
ErrorsUNIMPLEMENTED supportsRuledObstacleQuery() is false
ComplianceoptionalThis method must be implemented if supportsRuledObstacleQuery() is true.
MethodmatchAnyRuledObstacle
Description

Matches rules mapped to any obstacle.

Parametersbooleanmatch true for rules mapped to any obstacle, false to match rules mapped to no obstacles
CompliancemandatoryThis method must be implemented.
MethodclearRuledObstacleTerms
Description

Clears the obstacle query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchMapId
Description

Matches enablers mapped to an map.

Parametersosid.id.IdmapIdthe map Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT mapId is null
CompliancemandatoryThis method must be implemented.
MethodclearMapIdTerms
Description

Clears the map Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsMapQuery
Description

Tests if an MapQuery is available.

Returnboolean true if an map query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetMapQuery
Description

Gets the query for an map. Multiple retrievals produce a nested OR term.

Returnosid.mapping.MapQuerythe map query
ErrorsUNIMPLEMENTED supportsMapQuery() is false
ComplianceoptionalThis method must be implemented if supportsMapQuery() is true.
MethodclearMapTerms
Description

Clears the map query terms.

CompliancemandatoryThis method must be implemented.
MethodgetObstacleEnablerQueryRecord
Description

Gets the obstacle enabler query record corresponding to the given ObstacleEnabler record Type. Multiple record retrievals produce a nested OR term.

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