Interface JobProcessorEnablerQuery

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

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

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

  • Method Details

    • matchRuledJobProcessorId

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

    • clearRuledJobProcessorIdTerms

      void clearRuledJobProcessorIdTerms()
      Clears the job processor Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsRuledJobProcessorQuery

      boolean supportsRuledJobProcessorQuery()
      Tests if an JobProcessorQuery is available.
      Returns:
      true if a job processor query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getRuledJobProcessorQuery

      JobProcessorQuery getRuledJobProcessorQuery()
      Gets the query for a job processor. Multiple retrievals produce a nested OR term.
      Returns:
      the job processor query
      Throws:
      UnimplementedException - supportsRuledJobProcessorQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRuledJobProcessorQuery()} is {@code true}.

    • matchAnyRuledJobProcessor

      void matchAnyRuledJobProcessor(boolean match)
      Matches enablers mapped to any job processor.
      Parameters:
      match - true for enablers mapped to any job processor, false to match enablers mapped to no job processors
      Compliance:
      mandatory - This method must be implemented.

    • clearRuledJobProcessorTerms

      void clearRuledJobProcessorTerms()
      Clears the job processor query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchFoundryId

      void matchFoundryId(Id foundryId, boolean match)
      Matches enablers 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.

    • getJobProcessorEnablerQueryRecord

      JobProcessorEnablerQueryRecord getJobProcessorEnablerQueryRecord(Type jobProcessorEnablerRecordType) throws OperationFailedException
      Gets the job processor enabler query record corresponding to the given JobProcessorEnabler record Type. Multiple record retrievals produce a nested OR term.
      Parameters:
      jobProcessorEnablerRecordType - a job processor enabler record type
      Returns:
      the job processor enabler query record
      Throws:
      NullArgumentException - jobProcessorEnablerRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(jobProcessorEnablerRecordType) is false
      Compliance:
      mandatory - This method must be implemented.