Interface ItemSearchOrder

All Superinterfaces:
Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, Suppliable
public interface ItemSearchOrder extends OsidObjectSearchOrder

An interface for specifying the ordering of search results.

  • Method Details

    • orderByCategory

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

    • supportsCategorySearchOrder

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

    • getCategorySearchOrder

      CategorySearchOrder getCategorySearchOrder()
      Specifies a preference for ordering the result set by the category.
      Returns:
      the category search order
      Throws:
      UnimplementedException - supportsCategorySearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCategorySearchOrder()} is {@code true} .

    • orderByAccount

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

    • supportsAccountSearchOrder

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

    • getAccountSearchOrder

      AccountSearchOrder getAccountSearchOrder()
      Specifies a preference for ordering the result set by the account.
      Returns:
      the account search order
      Throws:
      UnimplementedException - supportsAccountSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAccountSearchOrder()} is {@code true} .

    • orderByProduct

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

    • supportsProductSearchOrder

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

    • getProductSearchOrder

      ProductSearchOrder getProductSearchOrder()
      Specifies a preference for ordering the result set by the product.
      Returns:
      the product search order
      Throws:
      UnimplementedException - supportsProductSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProductSearchOrder()} is {@code true} .

    • orderByAmount

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

    • orderByDebit

      void orderByDebit(SearchOrderStyle style)
      Specifies a preference for ordering the result set by debit.
      Parameters:
      style - a 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 interval.
      Parameters:
      style - a search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • getItemSearchOrderRecord

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