Interface PoolEnablerQueryInspector

All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidEnablerQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidOperableQueryInspector, OsidQueryInspector, OsidRuleQueryInspector, OsidTemporalQueryInspector
public interface PoolEnablerQueryInspector extends OsidEnablerQueryInspector

This is the query inspector for examining pool enabler queries.

Like all OsidQueryInspectors, PoolEnablerQueryInspector is stateful and must not be accessed by multiple processing threads.

  • Method Details

    • getRuledPoolIdTerms

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

    • getRuledPoolTerms

      PoolQueryInspector[] getRuledPoolTerms()
      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.

    • getPoolEnablerQueryInspectorRecord

      PoolEnablerQueryInspectorRecord getPoolEnablerQueryInspectorRecord(Type poolEnablerRecordType) throws OperationFailedException
      Gets the pool enabler query inspector record corresponding to the given PoolEnabler record Type.
      Parameters:
      poolEnablerRecordType - a pool enabler record type
      Returns:
      the pool enabler query inspector record
      Throws:
      NullArgumentException - poolEnablerRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(poolEnablerRecordType) is false
      Compliance:
      mandatory - This method must be implemented.