Interface MapQueryInspector

All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidCatalogQueryInspector, OsidExtensibleQueryInspector, OsidFederateableQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidSourceableQueryInspector
public interface MapQueryInspector extends OsidCatalogQueryInspector

This is the query inspector for searching maps.

  • Method Details

    • getLocationIdTerms

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

    • getLocationTerms

      LocationQueryInspector[] getLocationTerms()
      Gets the location 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.

    • 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.

    • getAncestorMapIdTerms

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

    • getAncestorMapTerms

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

    • getDescendantMapIdTerms

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

    • getDescendantMapTerms

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

    • getMapQueryInspectorRecord

      MapQueryInspectorRecord getMapQueryInspectorRecord(Type mapRecordType) throws OperationFailedException
      Gets the record query inspector interface corresponding to the given Map record Type .
      Parameters:
      mapRecordType - a map record type
      Returns:
      the map query inspector record
      Throws:
      NullArgumentException - mapRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(mapRecordType) is false
      Compliance:
      mandatory - This method must be implemented.