BasicSearchRequest (streams-processor-pipl 0.6.1 API)

java.lang.Object
- org.apache.streams.pipl.api.SearchRequest
- - org.apache.streams.pipl.api.BasicSearchRequest

All Implemented Interfaces:: Serializable

public class BasicSearchRequest
extends SearchRequest
implements Serializable

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

BasicSearchRequest()

Constructors
Constructor and Description
`BasicSearchRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object other)`
`Map<String,Object>`	`getAdditionalProperties()`
`String`	`getAge()` String, an exact (YY) or approximate (YY-YY) age.
`String`	`getCity()` City.
`String`	`getCountry()` A two-letter, Alpha-2 ISO-3166 country code.
`String`	`getEmail()` Email address.
`String`	`getFirstName()` First name, minimum 2 characters.
`String`	`getHouse()` House number.
`String`	`getLastName()` Last name, minimum 2 characters.
`String`	`getMiddleName()` Middle name or middle initial.
`String`	`getPhone()` Home/work/mobile phone number.
`String`	`getRawAddress()` Full Address.
`String`	`getRawName()` Full Name.
`String`	`getState()` A United States, Canada, Great Britain or Australia state code.
`String`	`getStreet()` Street.
`String`	`getUrl()` Profile URL in a supported service.
`String`	`getUserId()` Unique ID in a supported service, must include the service name.
`String`	`getUsername()` Username/screen-name, minimum 3 characters.
`String`	`getZipcode()` ZIP Code.
`int`	`hashCode()`
`void`	`setAdditionalProperty(String name, Object value)`
`void`	`setAge(String age)` String, an exact (YY) or approximate (YY-YY) age.
`void`	`setCity(String city)` City.
`void`	`setCountry(String country)` A two-letter, Alpha-2 ISO-3166 country code.
`void`	`setEmail(String email)` Email address.
`void`	`setFirstName(String firstName)` First name, minimum 2 characters.
`void`	`setHouse(String house)` House number.
`void`	`setLastName(String lastName)` Last name, minimum 2 characters.
`void`	`setMiddleName(String middleName)` Middle name or middle initial.
`void`	`setPhone(String phone)` Home/work/mobile phone number.
`void`	`setRawAddress(String rawAddress)` Full Address.
`void`	`setRawName(String rawName)` Full Name.
`void`	`setState(String state)` A United States, Canada, Great Britain or Australia state code.
`void`	`setStreet(String street)` Street.
`void`	`setUrl(String url)` Profile URL in a supported service.
`void`	`setUserId(String userId)` Unique ID in a supported service, must include the service name.
`void`	`setUsername(String username)` Username/screen-name, minimum 3 characters.
`void`	`setZipcode(String zipcode)` ZIP Code.
`String`	`toString()`
`BasicSearchRequest`	`withAdditionalProperty(String name, Object value)`
`BasicSearchRequest`	`withAge(String age)`
`BasicSearchRequest`	`withCallback(String callback)`
`BasicSearchRequest`	`withCity(String city)`
`BasicSearchRequest`	`withCountry(String country)`
`BasicSearchRequest`	`withEmail(String email)`
`BasicSearchRequest`	`withFirstName(String firstName)`
`BasicSearchRequest`	`withHideSponsored(Boolean hideSponsored)`
`BasicSearchRequest`	`withHouse(String house)`
`BasicSearchRequest`	`withInferPersons(Boolean inferPersons)`
`BasicSearchRequest`	`withKey(String key)`
`BasicSearchRequest`	`withLastName(String lastName)`
`BasicSearchRequest`	`withLiveFeeds(Boolean liveFeeds)`
`BasicSearchRequest`	`withMatchRequirements(String matchRequirements)`
`BasicSearchRequest`	`withMiddleName(String middleName)`
`BasicSearchRequest`	`withMinimumMatch(Double minimumMatch)`
`BasicSearchRequest`	`withMinimumProbability(Double minimumProbability)`
`BasicSearchRequest`	`withPhone(String phone)`
`BasicSearchRequest`	`withPretty(Boolean pretty)`
`BasicSearchRequest`	`withRawAddress(String rawAddress)`
`BasicSearchRequest`	`withRawName(String rawName)`
`BasicSearchRequest`	`withShowSources(String showSources)`
`BasicSearchRequest`	`withSourceCategoryRequirements(String sourceCategoryRequirements)`
`BasicSearchRequest`	`withState(String state)`
`BasicSearchRequest`	`withStreet(String street)`
`BasicSearchRequest`	`withTopMatch(Boolean topMatch)`
`BasicSearchRequest`	`withUrl(String url)`
`BasicSearchRequest`	`withUserId(String userId)`
`BasicSearchRequest`	`withUsername(String username)`
`BasicSearchRequest`	`withZipcode(String zipcode)`

Methods inherited from class org.apache.streams.pipl.api.SearchRequest
getCallback, getHideSponsored, getInferPersons, getKey, getLiveFeeds, getMatchRequirements, getMinimumMatch, getMinimumProbability, getPretty, getShowSources, getSourceCategoryRequirements, getTopMatch, setCallback, setHideSponsored, setInferPersons, setKey, setLiveFeeds, setMatchRequirements, setMinimumMatch, setMinimumProbability, setPretty, setShowSources, setSourceCategoryRequirements, setTopMatch

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - BasicSearchRequest
```
public BasicSearchRequest()
```
- Method Detail
  - getEmail
```
public String getEmail()
```
    Email address.
  - setEmail
```
public void setEmail(String email)
```
    Email address.
  - withEmail
```
public BasicSearchRequest withEmail(String email)
```
  - getPhone
```
public String getPhone()
```
    Home/work/mobile phone number. We’ll try to parse the number using libphonenumber.
  - setPhone
```
public void setPhone(String phone)
```
    Home/work/mobile phone number. We’ll try to parse the number using libphonenumber.
  - withPhone
```
public BasicSearchRequest withPhone(String phone)
```
  - getUsername
```
public String getUsername()
```
    Username/screen-name, minimum 3 characters. There’s an advanced option to search by username or user-id at a specific service like superman@facebook.
  - setUsername
```
public void setUsername(String username)
```
    Username/screen-name, minimum 3 characters. There’s an advanced option to search by username or user-id at a specific service like superman@facebook.
  - withUsername
```
public BasicSearchRequest withUsername(String username)
```
  - getUserId
```
public String getUserId()
```
    Unique ID in a supported service, must include the service name.
  - setUserId
```
public void setUserId(String userId)
```
    Unique ID in a supported service, must include the service name.
  - withUserId
```
public BasicSearchRequest withUserId(String userId)
```
  - getUrl
```
public String getUrl()
```
    Profile URL in a supported service. This URL will be parsed to a username or user_id object.
  - setUrl
```
public void setUrl(String url)
```
    Profile URL in a supported service. This URL will be parsed to a username or user_id object.
  - withUrl
```
public BasicSearchRequest withUrl(String url)
```
  - getFirstName
```
public String getFirstName()
```
    First name, minimum 2 characters.
  - setFirstName
```
public void setFirstName(String firstName)
```
    First name, minimum 2 characters.
  - withFirstName
```
public BasicSearchRequest withFirstName(String firstName)
```
  - getLastName
```
public String getLastName()
```
    Last name, minimum 2 characters.
  - setLastName
```
public void setLastName(String lastName)
```
    Last name, minimum 2 characters.
  - withLastName
```
public BasicSearchRequest withLastName(String lastName)
```
  - getMiddleName
```
public String getMiddleName()
```
    Middle name or middle initial.
  - setMiddleName
```
public void setMiddleName(String middleName)
```
    Middle name or middle initial.
  - withMiddleName
```
public BasicSearchRequest withMiddleName(String middleName)
```
  - getRawName
```
public String getRawName()
```
    Full Name. Use this parameter if the accurate name parts (first/middle/last) are not available, this parameter will only be used in absence of first_name and last_name.
  - setRawName
```
public void setRawName(String rawName)
```
    Full Name. Use this parameter if the accurate name parts (first/middle/last) are not available, this parameter will only be used in absence of first_name and last_name.
  - withRawName
```
public BasicSearchRequest withRawName(String rawName)
```
  - getCountry
```
public String getCountry()
```
    A two-letter, Alpha-2 ISO-3166 country code.
  - setCountry
```
public void setCountry(String country)
```
    A two-letter, Alpha-2 ISO-3166 country code.
  - withCountry
```
public BasicSearchRequest withCountry(String country)
```
  - getState
```
public String getState()
```
    A United States, Canada, Great Britain or Australia state code. If a US state is provided and no country specified, we’ll assume the country to be US.
  - setState
```
public void setState(String state)
```
    A United States, Canada, Great Britain or Australia state code. If a US state is provided and no country specified, we’ll assume the country to be US.
  - withState
```
public BasicSearchRequest withState(String state)
```
  - getCity
```
public String getCity()
```
    City.
  - setCity
```
public void setCity(String city)
```
    City.
  - withCity
```
public BasicSearchRequest withCity(String city)
```
  - getStreet
```
public String getStreet()
```
    Street.
  - setStreet
```
public void setStreet(String street)
```
    Street.
  - withStreet
```
public BasicSearchRequest withStreet(String street)
```
  - getHouse
```
public String getHouse()
```
    House number.
  - setHouse
```
public void setHouse(String house)
```
    House number.
  - withHouse
```
public BasicSearchRequest withHouse(String house)
```
  - getZipcode
```
public String getZipcode()
```
    ZIP Code.
  - setZipcode
```
public void setZipcode(String zipcode)
```
    ZIP Code.
  - withZipcode
```
public BasicSearchRequest withZipcode(String zipcode)
```
  - getRawAddress
```
public String getRawAddress()
```
    Full Address. Use this parameter if the accurate address parts (country/state/city…) are not available.
  - setRawAddress
```
public void setRawAddress(String rawAddress)
```
    Full Address. Use this parameter if the accurate address parts (country/state/city…) are not available.
  - withRawAddress
```
public BasicSearchRequest withRawAddress(String rawAddress)
```
  - getAge
```
public String getAge()
```
    String, an exact (YY) or approximate (YY-YY) age.
  - setAge
```
public void setAge(String age)
```
    String, an exact (YY) or approximate (YY-YY) age.
  - withAge
```
public BasicSearchRequest withAge(String age)
```
  - withKey
```
public BasicSearchRequest withKey(String key)
```
    Overrides:
    
    withKey in class SearchRequest
  - withPretty
```
public BasicSearchRequest withPretty(Boolean pretty)
```
    Overrides:
    
    withPretty in class SearchRequest
  - withMinimumProbability
```
public BasicSearchRequest withMinimumProbability(Double minimumProbability)
```
    Overrides:
    
    withMinimumProbability in class SearchRequest
  - withInferPersons
```
public BasicSearchRequest withInferPersons(Boolean inferPersons)
```
    Overrides:
    
    withInferPersons in class SearchRequest
  - withMinimumMatch
```
public BasicSearchRequest withMinimumMatch(Double minimumMatch)
```
    Overrides:
    
    withMinimumMatch in class SearchRequest
  - withShowSources
```
public BasicSearchRequest withShowSources(String showSources)
```
    Overrides:
    
    withShowSources in class SearchRequest
  - withHideSponsored
```
public BasicSearchRequest withHideSponsored(Boolean hideSponsored)
```
    Overrides:
    
    withHideSponsored in class SearchRequest
  - withLiveFeeds
```
public BasicSearchRequest withLiveFeeds(Boolean liveFeeds)
```
    Overrides:
    
    withLiveFeeds in class SearchRequest
  - withMatchRequirements
```
public BasicSearchRequest withMatchRequirements(String matchRequirements)
```
    Overrides:
    
    withMatchRequirements in class SearchRequest
  - withSourceCategoryRequirements
```
public BasicSearchRequest withSourceCategoryRequirements(String sourceCategoryRequirements)
```
    Overrides:
    
    withSourceCategoryRequirements in class SearchRequest
  - withCallback
```
public BasicSearchRequest withCallback(String callback)
```
    Overrides:
    
    withCallback in class SearchRequest
  - withTopMatch
```
public BasicSearchRequest withTopMatch(Boolean topMatch)
```
    Overrides:
    
    withTopMatch in class SearchRequest
  - getAdditionalProperties
```
public Map<String,Object> getAdditionalProperties()
```
    Overrides:
    
    getAdditionalProperties in class SearchRequest
  - setAdditionalProperty
```
public void setAdditionalProperty(String name,
                                  Object value)
```
    Overrides:
    
    setAdditionalProperty in class SearchRequest
  - withAdditionalProperty
```
public BasicSearchRequest withAdditionalProperty(String name,
                                                 Object value)
```
    Overrides:
    
    withAdditionalProperty in class SearchRequest
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class SearchRequest
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class SearchRequest
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class SearchRequest

Class BasicSearchRequest

Constructor Summary

Method Summary

Methods inherited from class org.apache.streams.pipl.api.SearchRequest

Methods inherited from class java.lang.Object

Constructor Detail

BasicSearchRequest

Method Detail

getEmail

setEmail

withEmail

getPhone

setPhone

withPhone

getUsername

setUsername

withUsername

getUserId

setUserId

withUserId

getUrl

setUrl

withUrl

getFirstName

setFirstName

withFirstName

getLastName

setLastName

withLastName

getMiddleName

setMiddleName

withMiddleName

getRawName

setRawName

withRawName

getCountry

setCountry

withCountry

getState

setState

withState

getCity

setCity

withCity

getStreet

setStreet

withStreet

getHouse

setHouse

withHouse

getZipcode

setZipcode

withZipcode

getRawAddress

setRawAddress

withRawAddress

getAge

setAge

withAge

withKey

withPretty

withMinimumProbability

withInferPersons

withMinimumMatch

withShowSources

withHideSponsored

withLiveFeeds

withMatchRequirements

withSourceCategoryRequirements

withCallback

withTopMatch

getAdditionalProperties

setAdditionalProperty

withAdditionalProperty

toString

hashCode

equals