Interface QueueQuery

All Superinterfaces:
Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidGovernatorQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidOperableQuery, OsidQuery, OsidSourceableQuery, OsidSubjugateableQuery, Suppliable
public interface QueueQuery extends OsidGovernatorQuery, OsidSubjugateableQuery

This is the query for searching queues. Each method match specifies an AND term while multiple invocations of the same method produce a nested OR .

  • Method Details

    • matchBrokerId

      void matchBrokerId(Id brokerId, boolean match)
      Sets the broker Id for this query.
      Parameters:
      brokerId - the broker Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - brokerId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearBrokerIdTerms

      void clearBrokerIdTerms()
      Clears the broker Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsBrokerQuery

      boolean supportsBrokerQuery()
      Tests if a BrokerQuery is available.
      Returns:
      true if a broker query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getBrokerQuery

      BrokerQuery getBrokerQuery()
      Gets the query for a broker. Multiple retrievals produce a nested OR term.
      Returns:
      the broker query
      Throws:
      UnimplementedException - supportsBrokerQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerQuery()} is {@code true} .

    • clearBrokerTerms

      void clearBrokerTerms()
      Clears the broker query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchManagerId

      void matchManagerId(Id managerId, boolean match)
      Sets the manager Id for this query.
      Parameters:
      managerId - the manager Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - managerId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearManagerIdTerms

      void clearManagerIdTerms()
      Clears the manager Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsManagerQuery

      boolean supportsManagerQuery()
      Tests if a ResourceQuery is available.
      Returns:
      true if a manager query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getManagerQuery

      ResourceQuery getManagerQuery()
      Gets the query for a manager. Multiple retrievals produce a nested OR term.
      Returns:
      the manager query
      Throws:
      UnimplementedException - supportsManagerQuery() is false
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyManager

      void matchAnyManager(boolean match)
      Matches queues that have any manager.
      Parameters:
      match - true to match queues with any manager, false to match queues with no manager
      Compliance:
      mandatory - This method must be implemented.

    • clearManagerTerms

      void clearManagerTerms()
      Clears the manager query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchSize

      void matchSize(long start, long end, boolean match)
      Matches queues of the given size inclusive.
      Parameters:
      start - start of range
      end - end of range
      match - true for a positive match, false for a negative match
      Throws:
      InvalidArgumentException - start is greater than end
      Compliance:
      mandatory - This method must be implemented.

    • matchAnySize

      void matchAnySize(boolean match)
      Matches queues with any known size.
      Parameters:
      match - true for a positive match, false for a negative match
      Compliance:
      mandatory - This method must be implemented.

    • clearSizeTerms

      void clearSizeTerms()
      Clears the size query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchEWA

      void matchEWA(Duration start, Duration end, boolean match)
      Matches queues whose estimated waiting time is in the given range inclusive,.
      Parameters:
      start - start of range
      end - end of range
      match - true for a positive match, false for a negative match
      Throws:
      InvalidArgumentException - start is greater than end
      NullArgumentException - start or end is null
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyEWA

      void matchAnyEWA(boolean match)
      Matches queues with any estimated wiating time.
      Parameters:
      match - true for a positive match, false for a negative match
      Compliance:
      mandatory - This method must be implemented.

    • clearEWATerms

      void clearEWATerms()
      Clears the estimated waiting time query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchCanSpecifyProvisionable

      void matchCanSpecifyProvisionable(boolean match)
      Matches queues that permit requests for specific provisionables.
      Parameters:
      match - true for a positive match, false for a negative match
      Compliance:
      mandatory - This method must be implemented.

    • clearCanSpecifyProvisionableTerms

      void clearCanSpecifyProvisionableTerms()
      Clears the can request provisionables terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchRequestId

      void matchRequestId(Id requestId, boolean match)
      Sets the request Id for this query.
      Parameters:
      requestId - the request Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - requestId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearRequestIdTerms

      void clearRequestIdTerms()
      Clears the request Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsRequestQuery

      boolean supportsRequestQuery()
      Tests if a RequestQuery is available.
      Returns:
      true if a request query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getRequestQuery

      RequestQuery getRequestQuery()
      Gets the query for a Request . Multiple retrievals produce a nested OR term.
      Returns:
      the request query
      Throws:
      UnimplementedException - supportsRequestQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRequestQuery()} is {@code true} .

    • matchAnyRequest

      void matchAnyRequest(boolean match)
      Matches queues that have any request.
      Parameters:
      match - true to match queues with any request, false to match queues with no request
      Compliance:
      mandatory - This method must be implemented.

    • clearRequestTerms

      void clearRequestTerms()
      Clears the request query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchDistributorId

      void matchDistributorId(Id distributorId, boolean match)
      Sets the distributor Id for this query to match queues assigned to distributors.
      Parameters:
      distributorId - the distributor Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - distributorId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearDistributorIdTerms

      void clearDistributorIdTerms()
      Clears the distributor Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsDistributorQuery

      boolean supportsDistributorQuery()
      Tests if a DistributorQuery is available.
      Returns:
      true if a distributor query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getDistributorQuery

      DistributorQuery getDistributorQuery()
      Gets the query for a distributor. Multiple retrievals produce a nested OR term.
      Returns:
      the distributor query
      Throws:
      UnimplementedException - supportsDistributorQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDistributorQuery()} is {@code true} .

    • clearDistributorTerms

      void clearDistributorTerms()
      Clears the distributor query terms.
      Compliance:
      mandatory - This method must be implemented.

    • getQueueQueryRecord

      QueueQueryRecord getQueueQueryRecord(Type queueRecordType) throws OperationFailedException
      Gets the queue query record corresponding to the given Queue record Type .Multiple record retrievals produce a nested OR term.
      Parameters:
      queueRecordType - a queue record type
      Returns:
      the queue query record
      Throws:
      NullArgumentException - queueRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(queueRecordType) is false
      Compliance:
      mandatory - This method must be implemented.