Interface OrderSearchOrder

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

An interface for specifying the ordering of search results.

  • Method Details

    • orderByCustomer

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

    • supportsCustomerSearchOrder

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

    • getCustomerSearchOrder

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

    • orderByTotalCost

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

    • orderBySubmitDate

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

    • orderBySubmitter

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

    • supportsSubmitterSearchOrder

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

    • getSubmitterSearchOrder

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

    • orderBySubmittingAgent

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

    • supportsSubmittingAgentSearchOrder

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

    • getSubmittingAgentSearchOrder

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

    • orderByClosedDate

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

    • orderByCloser

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

    • supportsCloserSearchOrder

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

    • getCloserSearchOrder

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

    • orderByClosingAgent

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

    • supportsClosingAgentSearchOrder

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

    • getClosingAgentSearchOrder

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

    • getOrderSearchOrderRecord

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