Interface StoreQuery

All Superinterfaces:
Extensible, OsidBrowsableQuery, OsidCatalogQuery, OsidExtensibleQuery, OsidFederateableQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidSourceableQuery, Suppliable
public interface StoreQuery extends OsidCatalogQuery

This is the query for searching for stores. Each method specifies an AND term while multiple terms of the same method produce a nested OR.

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

  • Method Details

    • matchOrderId

      void matchOrderId(Id orderId, boolean match)
      Sets the order Id for this query to match orders assigned to stores.
      Parameters:
      orderId - an order Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - orderId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearOrderIdTerms

      void clearOrderIdTerms()
      Clears the order Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsOrderQuery

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

    • getOrderQuery

      OrderQuery getOrderQuery()
      Gets the query for an order.
      Returns:
      the order query
      Throws:
      UnimplementedException - supportsOrderQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsOrderQuery()} is {@code true}.

    • matchAnyOrder

      void matchAnyOrder(boolean match)
      Matches stores with any order.
      Parameters:
      match - true to match stores with any order, false to match stores with no orders
      Compliance:
      mandatory - This method must be implemented.

    • clearOrderTerms

      void clearOrderTerms()
      Clears the order terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchProductId

      void matchProductId(Id productId, boolean match)
      Sets the product Id for this query.
      Parameters:
      productId - a product Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - productId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearProductIdTerms

      void clearProductIdTerms()
      Clears the product Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsProductQuery

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

    • getProductQuery

      ProductQuery getProductQuery()
      Gets the query for a product.
      Returns:
      the product query
      Throws:
      UnimplementedException - supportsProductQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProductQuery()} is {@code true}.

    • matchAnyProduct

      void matchAnyProduct(boolean match)
      Matches stores with any product.
      Parameters:
      match - true to match stores with any product, false to match stores with no products
      Compliance:
      mandatory - This method must be implemented.

    • clearProductTerms

      void clearProductTerms()
      Clears the product terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchPriceScheduleId

      void matchPriceScheduleId(Id priceScheduleId, boolean match)
      Sets the price schedule Id for this query.
      Parameters:
      priceScheduleId - a price schedule Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - priceScheduleId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearPriceScheduleIdTerms

      void clearPriceScheduleIdTerms()
      Clears the price schedule Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsPriceScheduleQuery

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

    • getPriceScheduleQuery

      PriceScheduleQuery getPriceScheduleQuery()
      Gets the query for a price schedule.
      Returns:
      the price schedule query
      Throws:
      UnimplementedException - supportsPriceScheduleQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPriceScheduleQuery()} is {@code true}.

    • matchAnyPriceSchedule

      void matchAnyPriceSchedule(boolean match)
      Matches products with any price schedule.
      Parameters:
      match - true to match products with any price schedule, false to match products with no price schedule
      Compliance:
      mandatory - This method must be implemented.

    • clearPriceScheduleTerms

      void clearPriceScheduleTerms()
      Clears the price schedule terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchAncestorStoreId

      void matchAncestorStoreId(Id storeId, boolean match)
      Sets the store Id for this query to match stores that have the specified store as an ancestor.
      Parameters:
      storeId - a store Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - storeId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearAncestorStoreIdTerms

      void clearAncestorStoreIdTerms()
      Clears the ancestor store Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsAncestorStoreQuery

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

    • getAncestorStoreQuery

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

    • matchAnyAncestorStore

      void matchAnyAncestorStore(boolean match)
      Matches stores with any ancestor.
      Parameters:
      match - true to match stores with any ancestor, false to match root stores
      Compliance:
      mandatory - This method must be implemented.

    • clearAncestorStoreTerms

      void clearAncestorStoreTerms()
      Clears the ancestor store terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchDescendantStoreId

      void matchDescendantStoreId(Id storeId, boolean match)
      Sets the store Id for this query to match stores that have the specified store as a descendant.
      Parameters:
      storeId - a store Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - storeId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearDescendantStoreIdTerms

      void clearDescendantStoreIdTerms()
      Clears the descendant store Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsDescendantStoreQuery

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

    • getDescendantStoreQuery

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

    • matchAnyDescendantStore

      void matchAnyDescendantStore(boolean match)
      Matches stores with any descendant.
      Parameters:
      match - true to match stores with any descendant, false to match leaf stores
      Compliance:
      mandatory - This method must be implemented.

    • clearDescendantStoreTerms

      void clearDescendantStoreTerms()
      Clears the descendant store terms.
      Compliance:
      mandatory - This method must be implemented.

    • getStoreQueryRecord

      StoreQueryRecord getStoreQueryRecord(Type storeRecordType) throws OperationFailedException
      Gets the store query record corresponding to the given Store record Type.Multiple record retrievals produce a nested boolean OR term.
      Parameters:
      storeRecordType - a store record type
      Returns:
      the store query record
      Throws:
      NullArgumentException - storeRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(storeRecordType) is false
      Compliance:
      mandatory - This method must be implemented.