Interface ObstacleEnablerQuery

All Superinterfaces:
Extensible, OsidBrowsableQuery, OsidEnablerQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidOperableQuery, OsidQuery, OsidRuleQuery, OsidTemporalQuery, Suppliable
public interface ObstacleEnablerQuery extends OsidEnablerQuery

This is the query for searching obstacle enablers. Each method match specifies an AND term while multiple invocations of the same method produce a nested OR.

Like all OsidQueries, ObstacleEnablerQuery is stateful and must not be accessed by multiple processing threads.

  • Method Details

    • matchRuledObstacleId

      void matchRuledObstacleId(Id obstacleId, boolean match)
      Matches enablers mapped to an obstacle.
      Parameters:
      obstacleId - the obstacle Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - obstacleId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearRuledObstacleIdTerms

      void clearRuledObstacleIdTerms()
      Clears the obstacle Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsRuledObstacleQuery

      boolean supportsRuledObstacleQuery()
      Tests if an ObstacleQuery is available.
      Returns:
      true if an obstacle query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getRuledObstacleQuery

      ObstacleQuery getRuledObstacleQuery()
      Gets the query for an obstacle. Multiple retrievals produce a nested OR term.
      Returns:
      the obstacle query
      Throws:
      UnimplementedException - supportsRuledObstacleQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRuledObstacleQuery()} is {@code true}.

    • matchAnyRuledObstacle

      void matchAnyRuledObstacle(boolean match)
      Matches rules mapped to any obstacle.
      Parameters:
      match - true for rules mapped to any obstacle, false to match rules mapped to no obstacles
      Compliance:
      mandatory - This method must be implemented.

    • clearRuledObstacleTerms

      void clearRuledObstacleTerms()
      Clears the obstacle query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchMapId

      void matchMapId(Id mapId, boolean match)
      Matches enablers mapped to a map.
      Parameters:
      mapId - the map Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - mapId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearMapIdTerms

      void clearMapIdTerms()
      Clears the map Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsMapQuery

      boolean supportsMapQuery()
      Tests if a MapQuery is available.
      Returns:
      true if a map query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getMapQuery

      MapQuery getMapQuery()
      Gets the query for a map. Multiple retrievals produce a nested OR term.
      Returns:
      the map query
      Throws:
      UnimplementedException - supportsMapQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsMapQuery()} is {@code true}.

    • clearMapTerms

      void clearMapTerms()
      Clears the map query terms.
      Compliance:
      mandatory - This method must be implemented.

    • getObstacleEnablerQueryRecord

      ObstacleEnablerQueryRecord getObstacleEnablerQueryRecord(Type obstacleEnablerRecordType) throws OperationFailedException
      Gets the obstacle enabler query record corresponding to the given ObstacleEnabler record Type. Multiple record retrievals produce a nested OR term.
      Parameters:
      obstacleEnablerRecordType - an obstacle enabler record type
      Returns:
      the obstacle enabler query record
      Throws:
      NullArgumentException - obstacleEnablerRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(obstacleEnablerRecordType) is false
      Compliance:
      mandatory - This method must be implemented.