Interface BrokerQueryInspector

All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidGovernatorQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidOperableQueryInspector, OsidQueryInspector, OsidSourceableQueryInspector
public interface BrokerQueryInspector extends OsidGovernatorQueryInspector

This is the query inspector for examining broker queries.

  • Method Details

    • getBrokerageIdTerms

      IdTerm[] getBrokerageIdTerms()
      Gets the brokerage Id query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getBrokerageTerms

      ResourceQueryInspector[] getBrokerageTerms()
      Gets the brokerage query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getQueueIdTerms

      IdTerm[] getQueueIdTerms()
      Gets the queue Id query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getQueueTerms

      QueueQueryInspector[] getQueueTerms()
      Gets the queue query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getPoolIdTerms

      IdTerm[] getPoolIdTerms()
      Gets the pool Id query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getPoolTerms

      PoolQueryInspector[] getPoolTerms()
      Gets the pool query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getDistributorIdTerms

      IdTerm[] getDistributorIdTerms()
      Gets the distributor Id query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getDistributorTerms

      DistributorQueryInspector[] getDistributorTerms()
      Gets the distributor query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getBrokerQueryInspectorRecord

      BrokerQueryInspectorRecord getBrokerQueryInspectorRecord(Type brokerRecordType) throws OperationFailedException
      Gets the broker query inspector record corresponding to the given Broker record Type .
      Parameters:
      brokerRecordType - a broker record type
      Returns:
      the broker query inspector record
      Throws:
      NullArgumentException - brokerRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(brokerRecordType) is false
      Compliance:
      mandatory - This method must be implemented.