DiceQuery (Candidate Search Service)

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.dice
Class DiceQuery

java.lang.Object
  com.dice.DiceQuery

public class DiceQuery
extends java.lang.Object
extends java.lang.Object

The class holds the data passed to the server when the caller makes a query request.

$RCSfile: DiceQuery.html,v $
$Author: duket $
$Date: 2010/12/14 16:48:42 $

Original Author: duke _DOT_ takle _AT_ dice _DOT_ com
Date: February, 2010

Field Summary
`protected java.lang.String`	`city` If the value given is valid US postal code then a radius search is done else if there is only one region and the city and region combination is known a radius search is done.
`protected java.lang.String`	`country` ISO Country code for candidate
`protected int`	`daysBack` The maximum days ago the candidate's resume can have been submitted
`protected int[]`	`employeeType` Candidate desired taxable status
`protected int`	`offset` 0 based offset into the complete result set of the query
`protected java.lang.String`	`postalCode` See city
`protected java.lang.String`	`queryString` The free text search string
`protected int`	`radius` See city
`protected java.lang.String[]`	`region` If searching within United states this is the USPS abbreviation for state or states.
`protected int`	`returnCount` Number of candidate summaries to return
`protected int`	`searchType` The way the free text is searched:
`protected int`	`sortSpec` If sortSpec is given as 4001 the results are sorted by submission date descending else the results are sorted by relevance.
`protected int[]`	`workAuthorization` Look for candidates who have indicated the given work authorization set

Constructor Summary
`DiceQuery()`

Method Summary
`java.lang.String`	`getCity()`
`java.lang.String`	`getCountry()`
`int`	`getDaysBack()`
`int[]`	`getEmployeeType()`
`int`	`getOffset()`
`java.lang.String`	`getPostalCode()`
`java.lang.String`	`getQueryString()`
`int`	`getRadius()`
`java.lang.String[]`	`getRegion()`
`int`	`getReturnCount()`
`int`	`getSearchType()`
`int`	`getSortSpec()`
`int[]`	`getWorkAuthorization()`
`void`	`setCity(java.lang.String city)`
`void`	`setCountry(java.lang.String country)`
`void`	`setDaysBack(int daysBack)`
`void`	`setEmployeeType(int[] employeeType)` Candidate desired taxable status
`void`	`setOffset(int offset)`
`void`	`setPostalCode(java.lang.String postalCode)`
`void`	`setQueryString(java.lang.String queryString)`
`void`	`setRadius(int radius)`
`void`	`setRegion(java.lang.String[] region)`
`void`	`setReturnCount(int returnCount)`
`void`	`setSearchType(int searchType)` The way the free text is searched:
`void`	`setSortSpec(int sortSpec)` If sortSpec is given as 4001 the results are sorted by submission date descending else the results are sorted by relevance.
`void`	`setWorkAuthorization(int[] workAuthorization)` Look for candidates who have indicated the given work authorization set

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

Field Detail

country

protected java.lang.String country

ISO Country code for candidate

region

protected java.lang.String[] region

If searching within United states this is the USPS abbreviation for state or states. Note: if there is only one region given and a valid city or postal code then a radius search is done with radius given in postalCodeRadius.

city

protected java.lang.String city

If the value given is valid US postal code then a radius search is done else if there is only one region and the city and region combination is known a radius search is done. Otherwise this is ignored.

postalCode

protected java.lang.String postalCode

See city

radius

protected int radius

See city

queryString

protected java.lang.String queryString

The free text search string

daysBack

protected int daysBack

The maximum days ago the candidate's resume can have been submitted

searchType

protected int searchType

The way the free text is searched:

 3001: search for ANY of the words given in queryString
 3002: search for ALL of the words given in queryString
 3003: treat queryString as a BOOLEAN expression

sortSpec

protected int sortSpec

If sortSpec is given as 4001 the results are sorted by submission date descending else the results are sorted by relevance.

workAuthorization

protected int[] workAuthorization

Look for candidates who have indicated the given work authorization set

 1001: Authorized to work in the US
 1002: United States citizen
 1003 Green card holder
 1004: TN Permit holder
 1005: Need an H1 visa
 1006: Has an H1 visa

employeeType

protected int[] employeeType

Candidate desired taxable status

 2001: Fulltime W2 employee
 2002: corporate contract
 2003: 1099 contract
 2004: W2 contract
 2005: corporate contract with option to hire<
 2006: 1099 contract with option to hire
 2007: W2 contract with option to hire<

returnCount

protected int returnCount

Number of candidate summaries to return

offset

protected int offset

0 based offset into the complete result set of the query

Constructor Detail

DiceQuery

public DiceQuery()

Method Detail

getCountry

public java.lang.String getCountry()

setCountry

public void setCountry(java.lang.String country)

getRegion

public java.lang.String[] getRegion()

setRegion

public void setRegion(java.lang.String[] region)

getCity

public java.lang.String getCity()

setCity

public void setCity(java.lang.String city)

getRadius

public int getRadius()

setRadius

public void setRadius(int radius)

getQueryString

public java.lang.String getQueryString()

setQueryString

public void setQueryString(java.lang.String queryString)

getDaysBack

public int getDaysBack()

setDaysBack

public void setDaysBack(int daysBack)

getSearchType

public int getSearchType()

setSearchType

public void setSearchType(int searchType)