Interface SubscriptionSearchOrder

All Superinterfaces:
Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidRelationshipSearchOrder, OsidSearchOrder, OsidTemporalSearchOrder, Suppliable
public interface SubscriptionSearchOrder extends OsidRelationshipSearchOrder

An interface for specifying the ordering of search results.

  • Method Details

    • orderByDispatch

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

    • supportsDispatchSearchOrder

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

    • getDispatchSearchOrder

      DispatchSearchOrder getDispatchSearchOrder()
      Gets the dispatch order.
      Returns:
      the dispatch search order
      Throws:
      UnimplementedException - supportsDispatchSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDispatchSearchOrder()} is {@code true} .

    • orderBySubscriber

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

    • supportsSubscriberSearchOrder

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

    • getSubscriberSearchOrder

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

    • orderByAddress

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

    • supportsAddressSearchOrder

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

    • getAddressSearchOrder

      AddressSearchOrder getAddressSearchOrder()
      Gets the address order.
      Returns:
      the address search order
      Throws:
      UnimplementedException - supportsAddressSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAddressSearchOrder()} is {@code true} .

    • getSubscriptionSearchOrderRecord

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