OSID Specifications
mapping package
Version 3.0.0
Release Candidate Preview
mapping package
Version 3.0.0
Release Candidate Preview
| Interface | osid.mapping.MapQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidCatalogQueryInspector | ||
| Description |
This is the query inspector for searching maps. | ||
| Method | getLocationIdTerms | ||
| Description |
Gets the location | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getLocationTerms | ||
| Description |
Gets the location query terms. | ||
| Return | osid.mapping.LocationQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPathIdTerms | ||
| Description |
Gets the path | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPathTerms | ||
| Description |
Gets the path query terms. | ||
| Return | osid.mapping.path.PathQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRouteIdTerms | ||
| Description |
Gets the route | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRouteTerms | ||
| Description |
Gets the route query terms. | ||
| Return | osid.mapping.route.RouteQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorMapIdTerms | ||
| Description |
Gets the ancestor map | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorMapTerms | ||
| Description |
Gets the ancestor map query terms. | ||
| Return | osid.mapping.MapQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantMapIdTerms | ||
| Description |
Gets the descendant map | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantMapTerms | ||
| Description |
Gets the descendant map query terms. | ||
| Return | osid.mapping.MapQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getMapQueryInspectorRecord | ||
| Description |
Gets the record query inspector interface corresponding
to the given | ||
| Parameters | osid.type.Type | mapRecordType | a map record type |
| Return | osid.mapping.records.MapQueryInspectorRecord | the map query inspector record | |
| Errors | NULL_ARGUMENT | mapRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(mapRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |