OSID Specifications
mapping path rules package
Version 3.0.0
Release Candidate Preview
mapping path rules package
Version 3.0.0
Release Candidate Preview
| Interface | osid.mapping.path.rules.ObstacleEnablerQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidEnablerQueryInspector | ||
| Description |
This is the query interface for examining obstacle enabler queries. | ||
| Method | getRuledObstacleIdTerms | ||
| Description |
Gets the obstacle | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRuledObstacleTerms | ||
| Description |
Gets the obstacle query terms. | ||
| Return | osid.mapping.path.ObstacleQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getMapIdTerms | ||
| Description |
Gets the map | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getMapTerms | ||
| Description |
Gets the map query terms. | ||
| Return | osid.mapping.MapQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getObstacleEnablerQueryInspectorRecord | ||
| Description |
Gets the obstacle enabler query inspector record
corresponding to the given | ||
| Parameters | osid.type.Type | obstacleEnablerRecordType | an obstacle enabler record type |
| Return | osid.mapping.path.rules.records.ObstacleEnablerQueryInspectorRecord | the obstacle enabler query inspector 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. | |