org.apache.streams.sysomos.provider

Interface RequestBuilder

All Known Implementing Classes:

AbstractRequestBuilder, ContentRequestBuilder

public interface RequestBuilder

Simplifying abstraction that aids in building a request to the Sysomos API in a chained fashion.

Method Summary

Modifier and Type	Method and Description
BeatApi.BeatResponse	execute() Executes the request to the Sysomos Heartbeat API and returns a valid response
URL	getRequestUrl() Returns the full url need to execute a request.
RequestBuilder	setAddedAfterDate(org.joda.time.DateTime afterDate) Sets the date after which documents should be returned from Sysomos.
RequestBuilder	setAddedBeforeDate(org.joda.time.DateTime beforeDate) Sets the date before which documents should be returned from Sysomos.
RequestBuilder	setHeartBeatId(int hid) Sets the Sysomos Heartbeat ID.
RequestBuilder	setHeartBeatId(String hid) Sets the Sysomos Heartbeat ID as a String.
RequestBuilder	setOffset(long offset) Sets the starting offset for the number of documents given the other parameters.
RequestBuilder	setReturnSetSize(long size) Sets the size of the expected response.

Method Detail

setAddedAfterDate

RequestBuilder setAddedAfterDate(org.joda.time.DateTime afterDate)

Sets the date after which documents should be returned from Sysomos.

Parameters:

afterDate - the DateTime instance representing the after date

Returns:

The RequestBuilder for continued Chaining

setAddedBeforeDate

RequestBuilder setAddedBeforeDate(org.joda.time.DateTime beforeDate)

Sets the date before which documents should be returned from Sysomos.

Parameters:

beforeDate - the DateTime instance representing the before date

Returns:

The RequestBuilder for continued Chaining

setReturnSetSize

RequestBuilder setReturnSetSize(long size)

Sets the size of the expected response.

Parameters:

size - the number of documents

Returns:

The RequestBuilder for continued Chaining

setOffset

RequestBuilder setOffset(long offset)

Sets the starting offset for the number of documents given the other parameters.

Parameters:

offset - the starting offset

Returns:

The RequestBuilder for continued Chaining

setHeartBeatId

RequestBuilder setHeartBeatId(int hid)

Sets the Sysomos Heartbeat ID.

Parameters:

hid - Heartbeat ID

Returns:

The RequestBuilder for continued Chaining

setHeartBeatId

RequestBuilder setHeartBeatId(String hid)

Sets the Sysomos Heartbeat ID as a String.

Parameters:

hid - Heartbeat ID string

Returns:

The RequestBuilder for continued Chaining

getRequestUrl

URL getRequestUrl()

Returns the full url need to execute a request.

Example: http://api.sysomos.com/dev/v1/heartbeat/content?apiKey=YOUR -APIKEY&hid=YOUR-HEARTBEAT-ID&offset=0&size=10& addedAfter=2010-10-15T13:00:00Z&addedBefore=2010-10-18T13:00:00Z

Returns:

the URL to use when making requests of Sysomos Heartbeat

execute

BeatApi.BeatResponse execute()

Executes the request to the Sysomos Heartbeat API and returns a valid response