Interface RequestSearchOrder

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

An interface for specifying the ordering of search results.

  • Method Details

    • orderByRequestTransaction

      void orderByRequestTransaction(SearchOrderStyle style)
      Orders the results by the request transaction.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsRequestTransactionSearchOrder

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

    • getRequestTransactionSearchOrder

      RequestTransactionSearchOrder getRequestTransactionSearchOrder()
      Gets the request transaction search order.
      Returns:
      the request transaction search order
      Throws:
      IllegalStateException - supportsRequestTransactionSearchOrder() is false
      Compliance:
      mandatory - This method must be implemented.

    • orderByQueue

      void orderByQueue(SearchOrderStyle style)
      Orders the results by queue.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsQueueSearchOrder

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

    • getQueueSearchOrder

      QueueSearchOrder getQueueSearchOrder()
      Gets the queue search order.
      Returns:
      the queue search order
      Throws:
      IllegalStateException - supportsQueueSearchOrder() is false
      Compliance:
      mandatory - This method must be implemented.

    • orderByRequestDate

      void orderByRequestDate(SearchOrderStyle style)
      Orders the results by request date.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByRequester

      void orderByRequester(SearchOrderStyle style)
      Orders the results by the requester.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsRequesterSearchOrder

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

    • getRequesterSearchOrder

      ResourceSearchOrder getRequesterSearchOrder()
      Gets the resource search order.
      Returns:
      the resource search order
      Throws:
      IllegalStateException - supportsRequesterSearchOrder() is false
      Compliance:
      mandatory - This method must be implemented.

    • orderByRequestingAgent

      void orderByRequestingAgent(SearchOrderStyle style)
      Orders the results by requesting agent.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsRequestingAgentSearchOrder

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

    • getRequestingAgentSearchOrder

      AgentSearchOrder getRequestingAgentSearchOrder()
      Gets the resource search order.
      Returns:
      the agent search order
      Throws:
      IllegalStateException - supportsRequestingAgentSearchOrder() is false
      Compliance:
      mandatory - This method must be implemented.

    • orderByPool

      void orderByPool(SearchOrderStyle style)
      Orders the results by pool.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsPoolSearchOrder

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

    • getPoolSearchOrder

      PoolSearchOrder getPoolSearchOrder()
      Gets the pool search order.
      Returns:
      the pool search order
      Throws:
      IllegalStateException - supportsPoolSearchOrder() is false
      Compliance:
      mandatory - This method must be implemented.

    • orderByExchangeProvision

      void orderByExchangeProvision(SearchOrderStyle style)
      Orders the results by exchange resource.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsExchangeProvisionSearchOrder

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

    • getExchangeProvisionSearchOrder

      ProvisionSearchOrder getExchangeProvisionSearchOrder()
      Gets the exchange provision search order.
      Returns:
      the provision search order
      Throws:
      IllegalStateException - supportsExchangeProvisionSearchOrder() is false
      Compliance:
      mandatory - This method must be implemented.

    • orderByOriginProvision

      void orderByOriginProvision(SearchOrderStyle style)
      Orders the results by origin provision.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsOriginProvisionSearchOrder

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

    • getOriginProvisionSearchOrder

      ProvisionSearchOrder getOriginProvisionSearchOrder()
      Gets the origin provision search order.
      Returns:
      the provision search order
      Throws:
      IllegalStateException - supportsOriginProvisionSearchOrder() is false
      Compliance:
      mandatory - This method must be implemented.

    • orderByPosition

      void orderByPosition(SearchOrderStyle style)
      Orders the results by position.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByEWA

      void orderByEWA(SearchOrderStyle style)
      Orders the results by the estimated waiting time.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • getRequestSearchOrderRecord

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