Interface LocationQueryInspector

All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidFederateableQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector

public interface LocationQueryInspector extends OsidObjectQueryInspector, OsidFederateableQueryInspector

This is the query inspector for searching locations.

  • Method Details

    • getCoordinateTerms

      CoordinateTerm[] getCoordinateTerms()
      Gets the coordinate query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.
    • getContainedSpatialUnitTerms

      SpatialUnitTerm[] getContainedSpatialUnitTerms()
      Gets the contained spatial unit query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.
    • getOverlappingSpatialUnitTerms

      SpatialUnitTerm[] getOverlappingSpatialUnitTerms()
      Gets the overlapping spatial unit query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.
    • getSpatialUnitTerms

      SpatialUnitTerm[] getSpatialUnitTerms()
      Gets the spatial unit query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.
    • getRouteIdTerms

      IdTerm[] getRouteIdTerms()
      Gets the route Id query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.
    • getRouteTerms

      RouteQueryInspector[] getRouteTerms()
      Gets the route query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.
    • getPathIdTerms

      IdTerm[] getPathIdTerms()
      Gets the path Id query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.
    • getPathTerms

      PathQueryInspector[] getPathTerms()
      Gets the path query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.
    • getContainingLocationIdTerms

      IdTerm[] getContainingLocationIdTerms()
      Gets the containing location Id query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.
    • getContainingLocationTerms

      LocationQueryInspector[] getContainingLocationTerms()
      Gets the containing location query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.
    • getContainedLocationIdTerms

      IdTerm[] getContainedLocationIdTerms()
      Gets the contained location Id query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.
    • getContainedLocationTerms

      LocationQueryInspector[] getContainedLocationTerms()
      Gets the contained location query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.
    • getMapIdTerms

      IdTerm[] getMapIdTerms()
      Gets the map Id query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.
    • getMapTerms

      MapQueryInspector[] getMapTerms()
      Gets the map query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.
    • getLocationQueryInspectorRecord

      LocationQueryInspectorRecord getLocationQueryInspectorRecord(Type locationRecordType) throws OperationFailedException
      Gets the location query inspector record corresponding to the given Location record Type .
      Parameters:
      locationRecordType - a location record type
      Returns:
      the location query inspector record
      Throws:
      NullArgumentException - locationRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(locationRecordType) is false
      Compliance:
      mandatory - This method must be implemented.