Interface JobConstrainerQuery

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

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

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

  • Method Details

    • matchRuledJobId

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

    • clearRuledJobIdTerms

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

    • supportsRuledJobQuery

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

    • getRuledJobQuery

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

    • matchAnyRuledJob

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

    • clearRuledJobTerms

      void clearRuledJobTerms()
      Clears the job 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.

    • getJobConstrainerQueryRecord

      JobConstrainerQueryRecord getJobConstrainerQueryRecord(Type jobConstrainerRecordType) throws OperationFailedException
      Gets the job constrainer query record corresponding to the given JobConstrainer record Type. Multiple record retrievals produce a nested OR term.
      Parameters:
      jobConstrainerRecordType - a job constrainer record type
      Returns:
      the job constrainer query record
      Throws:
      NullArgumentException - jobConstrainerRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(jobConstrainerRecordType) is false
      Compliance:
      mandatory - This method must be implemented.