Interface ReceiptSearchOrder

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

An interface for specifying the ordering of search results.

  • Method Details

    • orderByReceivedTime

      void orderByReceivedTime(SearchOrderStyle style)
      Specifies a preference for ordering messages by the received time.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByReceivingAgent

      void orderByReceivingAgent(SearchOrderStyle style)
      Specifies a preference for ordering messages by receiving agent.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsReceivingAgentSearchOrder

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

    • getReceivingAgentSearchOrder

      AgentSearchOrder getReceivingAgentSearchOrder()
      Gets the receiving agent order.
      Returns:
      the agent search order
      Throws:
      UnimplementedException - supportsReceivingAgentSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsReceivingAgentSearchOrder()} is {@code true} .

    • orderByRecipient

      void orderByRecipient(SearchOrderStyle style)
      Specifies a preference for ordering messages by recipient.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsRecipientSearchOrder

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

    • getRecipientSearchOrder

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

    • getReceiptSearchOrderRecord

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