Interface BrokerProcessorQuery

All Superinterfaces:
Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidOperableQuery, OsidProcessorQuery, OsidQuery, OsidRuleQuery, Suppliable
public interface BrokerProcessorQuery extends OsidProcessorQuery

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

  • Method Details

    • matchLeasing

      void matchLeasing(boolean match)
      Matches brokers that issue leases.
      Parameters:
      match - true to match brokers that issue leases, false to match brokers that issue permanent provisions
      Compliance:
      mandatory - This method must be implemented.

    • clearLeasingTerms

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

    • matchFixedLeaseDuration

      void matchFixedLeaseDuration(Duration from, Duration to, boolean match)
      Matches brokers that issue fixed duration leases between the given durations inclusive.
      Parameters:
      from - starting duration range
      to - ending duration range
      match - true for a positive match, false for a negative match
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - from or to is null
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyFixedLeaseDuration

      void matchAnyFixedLeaseDuration(boolean match)
      Matches brokers with any fixed lease duration.
      Parameters:
      match - true to match brokers with any fixed lease duration, returns, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • clearFixedLeaseDurationTerms

      void clearFixedLeaseDurationTerms()
      Clears the fixed lease duration query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchMustReturnProvisions

      void matchMustReturnProvisions(boolean match)
      Matches brokers that require provisions to be returned.
      Parameters:
      match - true to match brokers that require provision returns,, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • clearMustReturnProvisionsTerms

      void clearMustReturnProvisionsTerms()
      Clears the must return provisions query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchAllowsProvisionExchange

      void matchAllowsProvisionExchange(boolean match)
      Matches brokers that allow provision exchange.
      Parameters:
      match - true to match brokers that permit provision exchange, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • clearAllowsProvisionExchangeTerms

      void clearAllowsProvisionExchangeTerms()
      Clears the allows provision exchange query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchAllowsCompoundRequests

      void matchAllowsCompoundRequests(boolean match)
      Matches brokers that allow comound requests.
      Parameters:
      match - true to match brokers that permit compound requests, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • clearAllowsCompoundRequestsTerms

      void clearAllowsCompoundRequestsTerms()
      Clears the allows compound requests query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchRuledBrokerId

      void matchRuledBrokerId(Id distributorId, boolean match)
      Matches mapped to the broker.
      Parameters:
      distributorId - the broker Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - distributorId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearRuledBrokerIdTerms

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

    • supportsRuledBrokerQuery

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

    • getRuledBrokerQuery

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

    • matchAnyRuledBroker

      void matchAnyRuledBroker(boolean match)
      Matches mapped to any broker.
      Parameters:
      match - true for mapped to any broker, false to match mapped to no broker
      Compliance:
      mandatory - This method must be implemented.

    • clearRuledBrokerTerms

      void clearRuledBrokerTerms()
      Clears the broker 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 brokers 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.

    • getBrokerProcessorQueryRecord

      BrokerProcessorQueryRecord getBrokerProcessorQueryRecord(Type brokerProcessorRecordType) throws OperationFailedException
      Gets the broker processor query record corresponding to the given BrokerProcessor record Type . Multiple record retrievals produce a nested OR term.
      Parameters:
      brokerProcessorRecordType - a broker processor record type
      Returns:
      the broker processor query record
      Throws:
      NullArgumentException - brokerProcessorRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(brokerProcessorRecordType) is false
      Compliance:
      mandatory - This method must be implemented.