com.whitepages.proapi.api.response

Class Response<T extends Entity>

java.lang.Object

com.whitepages.proapi.api.response.Response<T>

public class Response<T extends Entity>
extends java.lang.Object

The Response is the root object for data returned from queries performed via the Client find methods.

The key properties of a Response are:

• The results (via getResults()): The list of the Entity instances found for the corresponding query,
• The response messages (via getResponseMessages()): A collection of Message instances pertaining to the response; these may include error conditions.

Response success can be determined via the isSuccess() and isFailure() accessors. In the event of a failure response, the cause of the failure is recorded in the response messages.

See Also:

Client

Constructor Summary

Constructors

Constructor and Description
Response(Client client, java.util.List<T> results, ResponseDictionary dictionary, ResponseMessages messages)

Method Summary

Methods

Modifier and Type	Method and Description
Client	getClient() Returns the Client instance used to execute the query that generated this response.
ResponseMessages	getResponseMessages() Returns the collection of Message instances for this response.
java.util.List<T>	getResults() Gets the list of resulting Entity instances found.
boolean	isFailure() Returns true if the query failed.
boolean	isSuccess() Returns true if the query succeeded.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Response

public Response(Client client,
        java.util.List<T> results,
        ResponseDictionary dictionary,
        ResponseMessages messages)

Method Detail

getResults

public java.util.List<T> getResults()

Gets the list of resulting Entity instances found.

Returns:

The list of results.

getResponseMessages

public ResponseMessages getResponseMessages()

Returns the collection of Message instances for this response.

Messages include errors and warnings encountered during execution of the query.

Returns:

The response messages.

See Also:

ResponseMessages, Message

getClient

public Client getClient()

Returns the Client instance used to execute the query that generated this response. This allows follow-up requests with the same configuration.

Returns:

The client used to execute this query.

See Also:

Client

isFailure

public boolean isFailure()

Returns true if the query failed.

See Also:

isSuccess()

isSuccess

public boolean isSuccess()

Returns true if the query succeeded.

See Also:

isFailure()