FilterCriteria (Textkernel Tx Java SDK 2.3.1 API)

java.lang.Object
- com.textkernel.tx.models.api.matching.request.FilterCriteria

public class FilterCriteria
extends Object

Criteria for filtering search/match results

Field Summary

Fields
Modifier and Type	Field and Description
`IntegerRange`	`AverageMonthsPerEmployer` Results much have `ExperienceSummary.AverageMonthsPerEmployer` within this range.
`List<String>`	`Certifications` Results must have at least one of the specified certifications.
`String`	`CurrentManagementLevel` Results must currently have at least one of the following management levels: None Low Mid High
`List<String>`	`DegreeNames` Results must have at least one of the specified degree names.
`List<String>`	`DegreeTypes` Results must have at least one of the specified degree types.
`List<String>`	`DocumentIds` Results must have one of the specified document ids (case-insensitive).
`List<String>`	`DocumentLanguages` Results must be written in one of the specified languages.
`List<String>`	`Employers` Results must have at least one of the specified employers.
`boolean`	`EmployersMustAllBeCurrentEmployer` When `true`, at least one employer in `Employers` must be found in the current time frame.
`List<String>`	`ExecutiveType` Results must have at least one of the following types of executive experience: None Executive Admin Accounting Operations Financial Marketing Business_Dev IT General Learning
`boolean`	`HasPatents` If `true`, results must have/require patent experience.
`boolean`	`HasSecurityCredentials` If `true`, results must have/require security credentials.
`boolean`	`IsAuthor` If `true`, results must have/require experience as an author.
`boolean`	`IsCurrentStudent` Results must have an education section listed as '- current'.
`boolean`	`IsMilitary` If `true`, results must have/require military experience.
`boolean`	`IsPublicSpeaker` If `true`, results must have/require public speaking experience.
`boolean`	`IsRecentGraduate` Results must have graduated within the last 18 months.
`boolean`	`IsTopStudent` Results must have an education with a normalized GPA of .75 or higher (for example, 3.0/4.0 or higher).
`IntegerRange`	`JobPredictiveIndex` Results much have `ExperienceSummary.FulltimeDirectHirePredictiveIndex` within this range.
`List<JobTitleFilter>`	`JobTitles` Results must have at least one of the specified job titles.
`List<String>`	`LanguagesKnown` Results must have/require these language competencies (2-letter ISO 639-1 language codes).
`boolean`	`LanguagesKnownMustAllExist` When `true`, all of the languages in `LanguagesKnown` must be found.
`LocationCriteria`	`LocationCriteria` Use to filter results based on location.
`IntegerRange`	`MonthsExperience` When specified, total work experience must fall within this range.
`IntegerRange`	`MonthsManagementExperience` Results must have management experience within this months range.
`RevisionDateRange`	`RevisionDateRange` When specified, the revision date of documents must fall within this range.
`List<String>`	`SchoolNames` Results must have at least one of the specified school names.
`String`	`SearchExpression` Full-text boolean semantic expresion.
`List<String>`	`SecurityCredentials` Results must have/require at least one of the security credentials specified.
`List<SkillFilter>`	`Skills` Results must have/require at least one of the specified skills.
`boolean`	`SkillsMustAllExist` When `true`, all of the skills in `Skills` must be found.
`List<String>`	`Taxonomies` Results must contain at least one of the specified best-fit taxonomy IDs or best-fit subtaxonomy IDs.
`List<String>`	`UserDefinedTags` List of user-defined tags.
`boolean`	`UserDefinedTagsMustAllExist` When `true`, all of the user-defined tags in `UserDefinedTags` must be found.

Constructor Summary

Constructors
Constructor and Description

FilterCriteria()

Constructors
Constructor and Description
`FilterCriteria()`

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - RevisionDateRange
```
public RevisionDateRange RevisionDateRange
```
    When specified, the revision date of documents must fall within this range.
  - DocumentIds
```
public List<String> DocumentIds
```
    Results must have one of the specified document ids (case-insensitive).
  - UserDefinedTags
```
public List<String> UserDefinedTags
```
    List of user-defined tags. Either all or at least one are required depending on the value of UserDefinedTagsMustAllExist
  - UserDefinedTagsMustAllExist
```
public boolean UserDefinedTagsMustAllExist
```
    When true, all of the user-defined tags in UserDefinedTags must be found. By default, this is false, which means that at least one of the UserDefinedTags must be found.
  - LocationCriteria
```
public LocationCriteria LocationCriteria
```
    Use to filter results based on location.
  - SearchExpression
```
public String SearchExpression
```
    Full-text boolean semantic expresion. For full details on the syntax and supported operations refer to https://developer.textkernel.com/tx-platform/v10/ai-matching/overview/querying/#ai-filtering-fulltext
  - HasPatents
```
public boolean HasPatents
```
    If true, results must have/require patent experience.
  - HasSecurityCredentials
```
public boolean HasSecurityCredentials
```
    If true, results must have/require security credentials.
  - SecurityCredentials
```
public List<String> SecurityCredentials
```
    Results must have/require at least one of the security credentials specified. Supports (*, ?) wildcard characters after the third character in the term as defined in https://developer.textkernel.com/tx-platform/v10/ai-matching/overview/querying/#ai-filtering-special-operators
  - IsAuthor
```
public boolean IsAuthor
```
    If true, results must have/require experience as an author.
  - IsPublicSpeaker
```
public boolean IsPublicSpeaker
```
    If true, results must have/require public speaking experience.
  - IsMilitary
```
public boolean IsMilitary
```
    If true, results must have/require military experience.
  - SchoolNames
```
public List<String> SchoolNames
```
    Results must have at least one of the specified school names. Supports (*, ?) wildcard characters after the third character in the term as defined in https://developer.textkernel.com/tx-platform/v10/ai-matching/overview/querying/#ai-filtering-special-operators
  - DegreeNames
```
public List<String> DegreeNames
```
    Results must have at least one of the specified degree names. Supports (*, ?) wildcard characters after the third character in the term as defined in hhttps://developer.textkernel.com/tx-platform/v10/ai-matching/overview/querying/#ai-filtering-special-operators
  - DegreeTypes
```
public List<String> DegreeTypes
```
    Results must have at least one of the specified degree types. One of:
    - specialeducation
    - someHighSchoolOrEquivalent
    - ged
    - secondary
    - highSchoolOrEquivalent
    - certification
    - vocational
    - someCollege
    - HND_HNC_OrEquivalent
    - associates
    - international
    - bachelors
    - somePostgraduate
    - masters
    - intermediategraduate
    - professional
    - postprofessional
    - doctorate
    - postdoctorate
  - Employers
```
public List<String> Employers
```
    Results must have at least one of the specified employers. Supports (*, ?) wildcard characters after the third character in the term as defined in https://developer.textkernel.com/tx-platform/v10/ai-matching/overview/querying/#ai-filtering-special-operators
  - EmployersMustAllBeCurrentEmployer
```
public boolean EmployersMustAllBeCurrentEmployer
```
    When true, at least one employer in Employers must be found in the current time frame.
  - MonthsExperience
```
public IntegerRange MonthsExperience
```
    When specified, total work experience must fall within this range.
  - DocumentLanguages
```
public List<String> DocumentLanguages
```
    Results must be written in one of the specified languages. (2-letter ISO 639-1 language codes)
  - Skills
```
public List<SkillFilter> Skills
```
    Results must have/require at least one of the specified skills.
  - SkillsMustAllExist
```
public boolean SkillsMustAllExist
```
    When true, all of the skills in Skills must be found. By default, this is false, which means that only one of the Skills must be found.
  - IsTopStudent
```
public boolean IsTopStudent
```
    Results must have an education with a normalized GPA of .75 or higher (for example, 3.0/4.0 or higher).
  - IsCurrentStudent
```
public boolean IsCurrentStudent
```
    Results must have an education section listed as '- current'.
  - IsRecentGraduate
```
public boolean IsRecentGraduate
```
    Results must have graduated within the last 18 months.
  - JobTitles
```
public List<JobTitleFilter> JobTitles
```
    Results must have at least one of the specified job titles.
  - ExecutiveType
```
public List<String> ExecutiveType
```
    Results must have at least one of the following types of executive experience:
    - None
    - Executive
    - Admin
    - Accounting
    - Operations
    - Financial
    - Marketing
    - Business_Dev
    - IT
    - General
    - Learning
  - Certifications
```
public List<String> Certifications
```
    Results must have at least one of the specified certifications. Supports (*, ?) wildcard characters after the third character in the term as defined in https://developer.textkernel.com/tx-platform/v10/ai-matching/overview/querying/#ai-filtering-special-operators
  - MonthsManagementExperience
```
public IntegerRange MonthsManagementExperience
```
    Results must have management experience within this months range.
  - CurrentManagementLevel
```
public String CurrentManagementLevel
```
    Results must currently have at least one of the following management levels:
    - None
    - Low
    - Mid
    - High
  - LanguagesKnown
```
public List<String> LanguagesKnown
```
    Results must have/require these language competencies (2-letter ISO 639-1 language codes).
    Either all or at least one are required depending on the value of LanguagesKnownMustAllExist
  - LanguagesKnownMustAllExist
```
public boolean LanguagesKnownMustAllExist
```
    When true, all of the languages in LanguagesKnown must be found. By default, this is false, which means that only one of the LanguagesKnown must be found.
  - Taxonomies
```
public List<String> Taxonomies
```
    Results must contain at least one of the specified best-fit taxonomy IDs or best-fit subtaxonomy IDs.
    See Taxonomy.getDefaults()
  - AverageMonthsPerEmployer
```
public IntegerRange AverageMonthsPerEmployer
```
    Results much have ExperienceSummary.AverageMonthsPerEmployer within this range. Only applicable for resumes; setting this when filtering jobs will cause an error.
  - JobPredictiveIndex
```
public IntegerRange JobPredictiveIndex
```
    Results much have ExperienceSummary.FulltimeDirectHirePredictiveIndex within this range. Only applicable for resumes; setting this when filtering jobs will cause an error.
- Constructor Detail
  - FilterCriteria
```
public FilterCriteria()
```

Class FilterCriteria

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

RevisionDateRange

DocumentIds

UserDefinedTags

UserDefinedTagsMustAllExist

LocationCriteria

SearchExpression

HasPatents

HasSecurityCredentials

SecurityCredentials

IsAuthor

IsPublicSpeaker

IsMilitary

SchoolNames

DegreeNames

DegreeTypes

Employers

EmployersMustAllBeCurrentEmployer

MonthsExperience

DocumentLanguages

Skills

SkillsMustAllExist

IsTopStudent

IsCurrentStudent

IsRecentGraduate

JobTitles

ExecutiveType

Certifications

MonthsManagementExperience

CurrentManagementLevel

LanguagesKnown

LanguagesKnownMustAllExist

Taxonomies

AverageMonthsPerEmployer

JobPredictiveIndex

Constructor Detail

FilterCriteria