Interface JobQuery

All Superinterfaces:
Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidGovernatorQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidOperableQuery, OsidQuery, OsidSourceableQuery, Suppliable
public interface JobQuery extends OsidGovernatorQuery

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

  • Method Details

    • matchEmployerId

      void matchEmployerId(Id employerId, boolean match)
      Sets a employer Id for this query.
      Parameters:
      employerId - a employer Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - employerId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearEmployerIdTerms

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

    • supportsEmployerQuery

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

    • getEmployerQuery

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

    • matchAnyEmployer

      void matchAnyEmployer(boolean match)
      Matches objects with any employer.
      Parameters:
      match - true to match objects with any employer, false to match objects with no employer
      Compliance:
      mandatory - This method must be implemented.

    • clearEmployerTerms

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

    • matchCompetencyId

      void matchCompetencyId(Id competencyId, boolean match)
      Sets the competency Id for this query.
      Parameters:
      competencyId - the competency Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - competencyId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearCompetencyIdTerms

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

    • supportsCompetencyQuery

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

    • getCompetencyQuery

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

    • matchAnyCompetency

      void matchAnyCompetency(boolean match)
      Matches work that have any competency.
      Parameters:
      match - true to match jobs with any competency, false to match work with no competency
      Compliance:
      mandatory - This method must be implemented.

    • clearCompetencyTerms

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

    • matchWorkId

      void matchWorkId(Id workId, boolean match)
      Sets the work Id for this query.
      Parameters:
      workId - the work Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - workId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearWorkIdTerms

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

    • supportsWorkQuery

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

    • getWorkQuery

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

    • clearWorkTerms

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

    • matchAvailabilityId

      void matchAvailabilityId(Id availabilityId, boolean match)
      Sets the availability Id for this query.
      Parameters:
      availabilityId - the availability Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - availabilityId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearAvailabilityIdTerms

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

    • supportsAvailabilityQuery

      boolean supportsAvailabilityQuery()
      Tests if an AvailabilityQuery is available.
      Returns:
      true if an availability query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getAvailabilityQuery

      AvailabilityQuery getAvailabilityQuery()
      Gets the query for an availability. Multiple retrievals produce a nested OR term.
      Returns:
      the availability query
      Throws:
      UnimplementedException - supportsAvailabilityQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAvailabilityQuery()} is {@code true} .

    • matchAnyAvailability

      void matchAnyAvailability(boolean match)
      Matches work that have any availability.
      Parameters:
      match - true to match work with any availability, false to match work with no availability
      Compliance:
      mandatory - This method must be implemented.

    • clearAvailabilityTerms

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

    • matchFoundryId

      void matchFoundryId(Id foundryId, boolean match)
      Sets the foundry Id for this query to match jobs assigned to foundries.
      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.

    • getJobQueryRecord

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