Interface PriceSearchOrder

All Superinterfaces:
Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidOperableSearchOrder, OsidRuleSearchOrder, OsidSearchOrder, OsidSubjugateableSearchOrder, Suppliable
public interface PriceSearchOrder extends OsidRuleSearchOrder, OsidSubjugateableSearchOrder

An interface for specifying the ordering of search results.

  • Method Details

    • orderByPriceSchedule

      void orderByPriceSchedule(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the price schedule.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsPriceScheduleSearchOrder

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

    • getPriceScheduleSearchOrder

      PriceScheduleSearchOrder getPriceScheduleSearchOrder()
      Gets the price schedule order.
      Returns:
      the price schedule search order
      Throws:
      UnimplementedException - supportsPriceScheduleSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPriceScheduleSearchOrder()} is {@code true} .

    • orderByMinimumQuantity

      void orderByMinimumQuantity(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the minimum quantity.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByMaximumQuantity

      void orderByMaximumQuantity(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the maximum quanttity.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByDemographic

      void orderByDemographic(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the demographic.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsDemographicSearchOrder

      boolean supportsDemographicSearchOrder()
      Tests if a resource search order is available.
      Returns:
      true if a demographic order is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getDemographicSearchOrder

      ResourceSearchOrder getDemographicSearchOrder()
      Gets the resource order.
      Returns:
      the resource search order
      Throws:
      UnimplementedException - supportsDemographicSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDemographicSearchOrder()} is {@code true} .

    • orderByAmount

      void orderByAmount(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the amount.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByRecurringInterval

      void orderByRecurringInterval(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the recurring interval.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • getPriceSearchOrderRecord

      PriceSearchOrderRecord getPriceSearchOrderRecord(Type priceRecordType) throws OperationFailedException
      Gets the price search order record corresponding to the given price record Type. Multiple retrievals return the same underlying object.
      Parameters:
      priceRecordType - a price record type
      Returns:
      the price search order record
      Throws:
      NullArgumentException - priceRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(priceRecordType) is false
      Compliance:
      mandatory - This method must be implemented.