com.datasift.client

Class BaseDataSiftResult

java.lang.Object

com.datasift.client.BaseDataSiftResult

All Implemented Interfaces:

DataSiftResult

Direct Known Subclasses:

Balance, Dpu, DynamicList, HistoricsPreview, HistoricsPreviewData, HistoricsQuery, HistoricsQueryList, HistoricsStatus, ManagedSource, ManagedSourceList, ManagedSourceLog, PreparedHistoricsQuery, PulledInteractions, PushCollection, PushLogMessages, PushSubscription, PushValidation, ReplaceList, Stream, Usage, Validation

public class BaseDataSiftResult
extends Object
implements DataSiftResult

Author:

Courtney Robinson

Field Summary

Fields

Modifier and Type	Field and Description
protected String	error
protected Response	response

Constructor Summary

Constructors

Constructor and Description
BaseDataSiftResult()

Method Summary

Methods

Modifier and Type	Method and Description
void	failed(Throwable e)
Throwable	failureCause()
String	getError()
Response	getResponse()
boolean	isAuthorizationSuccesful()
boolean	isSuccessful() A response is considered successful if if a response has been received, the response doesn't contain an error message AND the HTTP response status code is 200 to 399 (i.e.
int	rateLimit()
int	rateLimitCost() Not all API calls are created equally.
int	rateLimitRemaining()
void	setResponse(Response response)
void	successful()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

error

protected String error

response

protected Response response

Constructor Detail

BaseDataSiftResult

public BaseDataSiftResult()

Method Detail

isSuccessful

public boolean isSuccessful()

Description copied from interface: DataSiftResult

A response is considered successful if if a response has been received, the response doesn't contain an error message AND the HTTP response status code is 200 to 399 (i.e. OKs or redirects)

Specified by:

isSuccessful in interface DataSiftResult

Returns:

true if this API result was successful.

getResponse

public Response getResponse()

Specified by:

getResponse in interface DataSiftResult

setResponse

public void setResponse(Response response)

Specified by:

setResponse in interface DataSiftResult

failureCause

public Throwable failureCause()

Specified by:

failureCause in interface DataSiftResult

Returns:

If the request has failed, this returns the reason for the failure May* be null

isAuthorizationSuccesful

public boolean isAuthorizationSuccesful()

Specified by:

isAuthorizationSuccesful in interface DataSiftResult

Returns:

True if the response status is anything but a 401 Unauthorized

rateLimit

public int rateLimit()

Specified by:

rateLimit in interface DataSiftResult

Returns:

How much the rate limit is on this account DataSiftClient.DEFAULT_NUM if the information was not returned

rateLimitRemaining

public int rateLimitRemaining()

Specified by:

rateLimitRemaining in interface DataSiftResult

Returns:

How much is left of the rate limit quota or DataSiftClient.DEFAULT_NUM if the information was not returned

rateLimitCost

public int rateLimitCost()

Description copied from interface: DataSiftResult

Not all API calls are created equally.

Specified by:

rateLimitCost in interface DataSiftResult

Returns:

This tells you how much of your rate limit it took to generate this result or DataSiftClient.DEFAULT_NUM if the information was not returned

getError

public String getError()

Specified by:

getError in interface DataSiftResult

Returns:

if DataSiftResult.isSuccessful() == false then this returns the error message DataSift returned or null if true

toString

public String toString()

Overrides:

toString in class Object

failed

public void failed(Throwable e)

Specified by:

failed in interface DataSiftResult

successful

public void successful()

Specified by:

successful in interface DataSiftResult