Interface | osid.mapping.path.rules.ObstacleEnablerQuery | ||
---|---|---|---|
Implements | osid.OsidEnablerQuery | ||
Description |
This is the query for searching obstacle enablers. Each
method match specifies an | ||
Method | matchRuledObstacleId | ||
Description |
Matches enablers mapped to an obstacle. | ||
Parameters | osid.id.Id | obstacleId | the obstacle Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | obstacleId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearRuledObstacleIdTerms | ||
Description |
Clears the obstacle | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsRuledObstacleQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an obstacle query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRuledObstacleQuery | ||
Description |
Gets the query for an obstacle. Multiple retrievals
produce a nested | ||
Return | osid.mapping.path.ObstacleQuery | the obstacle query | |
Errors | UNIMPLEMENTED | supportsRuledObstacleQuery() is false | |
Compliance | optional | This method must be implemented if supportsRuledObstacleQuery()
is true. | |
Method | matchAnyRuledObstacle | ||
Description |
Matches rules mapped to any obstacle. | ||
Parameters | boolean | match | true for rules mapped to any obstacle, false
to match rules mapped to no obstacles |
Compliance | mandatory | This method must be implemented. | |
Method | clearRuledObstacleTerms | ||
Description |
Clears the obstacle query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchMapId | ||
Description |
Matches enablers mapped to an map. | ||
Parameters | osid.id.Id | mapId | the map Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | mapId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearMapIdTerms | ||
Description |
Clears the map | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsMapQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an map query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getMapQuery | ||
Description |
Gets the query for an map. Multiple retrievals produce
a nested | ||
Return | osid.mapping.MapQuery | the map query | |
Errors | UNIMPLEMENTED | supportsMapQuery() is false | |
Compliance | optional | This method must be implemented if supportsMapQuery() is
true. | |
Method | clearMapTerms | ||
Description |
Clears the map query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getObstacleEnablerQueryRecord | ||
Description |
Gets the obstacle enabler query record corresponding to
the given | ||
Parameters | osid.type.Type | obstacleEnablerRecordType | an obstacle enabler record type |
Return | osid.mapping.path.rules.records.ObstacleEnablerQueryRecord | the obstacle enabler query record | |
Errors | NULL_ARGUMENT | obstacleEnablerRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(obstacleEnablerRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |