SearchResponse (streams-processor-pipl 0.6.1 API)

java.lang.Object
- org.apache.streams.pipl.api.SearchResponse

All Implemented Interfaces:: Serializable

public class SearchResponse
extends Object
implements Serializable

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

SearchResponse()

Constructors
Constructor and Description
`SearchResponse()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object other)`
`Map<String,Object>`	`getAdditionalProperties()`
`AvailableData`	`getAvailableData()`
`Long`	`getAvailableSources()` The number of sources we know of that are relevant to the search.
`String`	`getError()` An error message, explaining an error that prevented your search from being run.
`Long`	`getHttpStatusCode()` The HTTP status code of the response.
`String`	`getMatchRequirements()` The canonical way to express the match requirement you’ve sent.
`Person`	`getPerson()`
`Long`	`getPersonsCount()` The number of persons returned in this API response.
`List<Person>`	`getPossiblePersons()` An array of person objects containing possible matches.
`Person`	`getQuery()`
`String`	`getSearchId()` An internal ID which identifies the search on our systems.
`List<Source>`	`getSources()` An array of source objects, in case you need to see where the data came from.
`Boolean`	`getTopMatch()` Whether top match was set in request.
`Long`	`getVisibleSources()` The number of sources returned in the sources array (if show_sources is not false).
`List<String>`	`getWarnings()` An array of warning strings.
`int`	`hashCode()`
`void`	`setAdditionalProperty(String name, Object value)`
`void`	`setAvailableData(AvailableData availableData)`
`void`	`setAvailableSources(Long availableSources)` The number of sources we know of that are relevant to the search.
`void`	`setError(String error)` An error message, explaining an error that prevented your search from being run.
`void`	`setHttpStatusCode(Long httpStatusCode)` The HTTP status code of the response.
`void`	`setMatchRequirements(String matchRequirements)` The canonical way to express the match requirement you’ve sent.
`void`	`setPerson(Person person)`
`void`	`setPersonsCount(Long personsCount)` The number of persons returned in this API response.
`void`	`setPossiblePersons(List<Person> possiblePersons)` An array of person objects containing possible matches.
`void`	`setQuery(Person query)`
`void`	`setSearchId(String searchId)` An internal ID which identifies the search on our systems.
`void`	`setSources(List<Source> sources)` An array of source objects, in case you need to see where the data came from.
`void`	`setTopMatch(Boolean topMatch)` Whether top match was set in request.
`void`	`setVisibleSources(Long visibleSources)` The number of sources returned in the sources array (if show_sources is not false).
`void`	`setWarnings(List<String> warnings)` An array of warning strings.
`String`	`toString()`
`SearchResponse`	`withAdditionalProperty(String name, Object value)`
`SearchResponse`	`withAvailableData(AvailableData availableData)`
`SearchResponse`	`withAvailableSources(Long availableSources)`
`SearchResponse`	`withError(String error)`
`SearchResponse`	`withHttpStatusCode(Long httpStatusCode)`
`SearchResponse`	`withMatchRequirements(String matchRequirements)`
`SearchResponse`	`withPerson(Person person)`
`SearchResponse`	`withPersonsCount(Long personsCount)`
`SearchResponse`	`withPossiblePersons(List<Person> possiblePersons)`
`SearchResponse`	`withQuery(Person query)`
`SearchResponse`	`withSearchId(String searchId)`
`SearchResponse`	`withSources(List<Source> sources)`
`SearchResponse`	`withTopMatch(Boolean topMatch)`
`SearchResponse`	`withVisibleSources(Long visibleSources)`
`SearchResponse`	`withWarnings(List<String> warnings)`

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

Constructor Detail
- SearchResponse
```
public SearchResponse()
```

Method Detail

getHttpStatusCode
```
public Long getHttpStatusCode()
```
The HTTP status code of the response. Successful calls will be 200.

setHttpStatusCode
```
public void setHttpStatusCode(Long httpStatusCode)
```
The HTTP status code of the response. Successful calls will be 200.

withHttpStatusCode

public SearchResponse withHttpStatusCode(Long httpStatusCode)

getVisibleSources
```
public Long getVisibleSources()
```
The number of sources returned in the sources array (if show_sources is not false).

setVisibleSources
```
public void setVisibleSources(Long visibleSources)
```
The number of sources returned in the sources array (if show_sources is not false).

withVisibleSources

public SearchResponse withVisibleSources(Long visibleSources)

getAvailableSources
```
public Long getAvailableSources()
```
The number of sources we know of that are relevant to the search.

setAvailableSources
```
public void setAvailableSources(Long availableSources)
```
The number of sources we know of that are relevant to the search.

withAvailableSources

public SearchResponse withAvailableSources(Long availableSources)

getPersonsCount
```
public Long getPersonsCount()
```
The number of persons returned in this API response.

setPersonsCount
```
public void setPersonsCount(Long personsCount)
```
The number of persons returned in this API response.

withPersonsCount

public SearchResponse withPersonsCount(Long personsCount)

getSearchId
```
public String getSearchId()
```
An internal ID which identifies the search on our systems. Useful for debugging.

setSearchId
```
public void setSearchId(String searchId)
```
An internal ID which identifies the search on our systems. Useful for debugging.

withSearchId

public SearchResponse withSearchId(String searchId)

getTopMatch
```
public Boolean getTopMatch()
```
Whether top match was set in request.

setTopMatch
```
public void setTopMatch(Boolean topMatch)
```
Whether top match was set in request.

withTopMatch

public SearchResponse withTopMatch(Boolean topMatch)

getQuery
```
public Person getQuery()
```

setQuery
```
public void setQuery(Person query)
```

withQuery

public SearchResponse withQuery(Person query)

getMatchRequirements
```
public String getMatchRequirements()
```
The canonical way to express the match requirement you’ve sent. Useful to see how we’ve parsed your criteria.

setMatchRequirements
```
public void setMatchRequirements(String matchRequirements)
```
The canonical way to express the match requirement you’ve sent. Useful to see how we’ve parsed your criteria.

withMatchRequirements

public SearchResponse withMatchRequirements(String matchRequirements)

getAvailableData

public AvailableData getAvailableData()

setAvailableData

public void setAvailableData(AvailableData availableData)

withAvailableData

public SearchResponse withAvailableData(AvailableData availableData)

getError
```
public String getError()
```
An error message, explaining an error that prevented your search from being run.

setError
```
public void setError(String error)
```
An error message, explaining an error that prevented your search from being run.

withError

public SearchResponse withError(String error)

getWarnings
```
public List<String> getWarnings()
```
An array of warning strings.

setWarnings

public void setWarnings(List<String> warnings)

An array of warning strings.

withWarnings

public SearchResponse withWarnings(List<String> warnings)

getPerson
```
public Person getPerson()
```

setPerson
```
public void setPerson(Person person)
```

withPerson

public SearchResponse withPerson(Person person)

getPossiblePersons
```
public List<Person> getPossiblePersons()
```
An array of person objects containing possible matches.

setPossiblePersons
```
public void setPossiblePersons(List<Person> possiblePersons)
```
An array of person objects containing possible matches.

withPossiblePersons

public SearchResponse withPossiblePersons(List<Person> possiblePersons)

getSources
```
public List<Source> getSources()
```
An array of source objects, in case you need to see where the data came from.

setSources
```
public void setSources(List<Source> sources)
```
An array of source objects, in case you need to see where the data came from.

withSources

public SearchResponse withSources(List<Source> sources)

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

setAdditionalProperty

public void setAdditionalProperty(String name,
                                  Object value)

withAdditionalProperty

public SearchResponse withAdditionalProperty(String name,
                                             Object value)

toString
```
public String toString()
```
Overrides:

toString in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

equals
```
public boolean equals(Object other)
```
Overrides:

equals in class Object

Class SearchResponse

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SearchResponse

Method Detail

getHttpStatusCode

setHttpStatusCode

withHttpStatusCode

getVisibleSources

setVisibleSources

withVisibleSources

getAvailableSources

setAvailableSources

withAvailableSources

getPersonsCount

setPersonsCount

withPersonsCount

getSearchId

setSearchId

withSearchId

getTopMatch

setTopMatch

withTopMatch

getQuery

setQuery

withQuery

getMatchRequirements

setMatchRequirements

withMatchRequirements

getAvailableData

setAvailableData

withAvailableData

getError

setError

withError

getWarnings

setWarnings

withWarnings

getPerson

setPerson

withPerson

getPossiblePersons

setPossiblePersons

withPossiblePersons

getSources

setSources

withSources

getAdditionalProperties

setAdditionalProperty

withAdditionalProperty

toString

hashCode

equals