Interface CommissionEnablerQuery

All Superinterfaces:
Extensible, OsidBrowsableQuery, OsidEnablerQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidOperableQuery, OsidQuery, OsidRuleQuery, OsidTemporalQuery, Suppliable
public interface CommissionEnablerQuery extends OsidEnablerQuery

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

Like all OsidQueries, CommissionEnablerQuery is stateful and must not be accessed by multiple processing threads.

  • Method Details

    • matchRuledCommissionId

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

    • clearRuledCommissionIdTerms

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

    • supportsRuledCommissionQuery

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

    • getRuledCommissionQuery

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

    • matchAnyRuledCommission

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

    • clearRuledCommissionTerms

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

    • matchFoundryId

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

    • clearFoundryIdTerms

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

    • supportsFoundryQuery

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

    • getFoundryQuery

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

    • clearFoundryTerms

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

    • getCommissionEnablerQueryRecord

      CommissionEnablerQueryRecord getCommissionEnablerQueryRecord(Type commissionEnablerRecordType) throws OperationFailedException
      Gets the commission enabler query record corresponding to the given CommissionEnabler record Type. Multiple record retrievals produce a nested OR term.
      Parameters:
      commissionEnablerRecordType - a commission enabler record type
      Returns:
      the commission enabler query record
      Throws:
      NullArgumentException - commissionEnablerRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(commissionEnablerRecordType) is false
      Compliance:
      mandatory - This method must be implemented.