Google Git
Sign in
apache / streams / refs/heads/asf-site / . / streams-contrib / streams-provider-sysomos / apidocs / org / apache / streams / sysomos / provider / ContentRequestBuilder.html
blob: b76f3ee53707231c52b30ad08d07e418bfc956bc [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_152) on Mon Apr 02 22:52:27 UTC 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ContentRequestBuilder (streams-provider-sysomos 0.5.2-SNAPSHOT API)</title>
<meta name="date" content="2018-04-02">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ContentRequestBuilder (streams-provider-sysomos 0.5.2-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ContentRequestBuilder.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/streams/sysomos/provider/AbstractRequestBuilder.html" title="class in org.apache.streams.sysomos.provider"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html" title="interface in org.apache.streams.sysomos.provider"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/streams/sysomos/provider/ContentRequestBuilder.html" target="_top">Frames</a></li>
<li><a href="ContentRequestBuilder.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.streams.sysomos.provider</div>
<h2 title="Class ContentRequestBuilder" class="title">Class ContentRequestBuilder</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/streams/sysomos/provider/AbstractRequestBuilder.html" title="class in org.apache.streams.sysomos.provider">org.apache.streams.sysomos.provider.AbstractRequestBuilder</a></li>
<li>
<ul class="inheritance">
<li>org.apache.streams.sysomos.provider.ContentRequestBuilder</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html" title="interface in org.apache.streams.sysomos.provider">RequestBuilder</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">ContentRequestBuilder</span>
extends <a href="../../../../../org/apache/streams/sysomos/provider/AbstractRequestBuilder.html" title="class in org.apache.streams.sysomos.provider">AbstractRequestBuilder</a>
implements <a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html" title="interface in org.apache.streams.sysomos.provider">RequestBuilder</a></pre>
<div class="block">Builds requests for the Sysomos Heartbeat Content API. This is the preferred method of
accessing data from Sysomoos Heartbeat</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/sysomos/provider/ContentRequestBuilder.html#MAX_ALLOWED_PER_REQUEST">MAX_ALLOWED_PER_REQUEST</a></span></code>
<div class="block">The max number of items you are allowed to get per request.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/sysomos/provider/ContentRequestBuilder.html#ContentRequestBuilder-java.lang.String-java.lang.String-">ContentRequestBuilder</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;baseUrl,
<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;apiKey)</code>
<div class="block">Constructs a new ContentRequestBuilder for the specified API key and Sysomos URL.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/sysomos/provider/ContentRequestBuilder.html#getRequestUrl--">getRequestUrl</a></span>()</code>
<div class="block">Gets the Request URL based on the local fields.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html" title="interface in org.apache.streams.sysomos.provider">RequestBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/sysomos/provider/ContentRequestBuilder.html#setAddedAfterDate-org.joda.time.DateTime-">setAddedAfterDate</a></span>(org.joda.time.DateTime&nbsp;afterDate)</code>
<div class="block">Sets the date after which documents should be returned from Sysomos.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html" title="interface in org.apache.streams.sysomos.provider">RequestBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/sysomos/provider/ContentRequestBuilder.html#setAddedBeforeDate-org.joda.time.DateTime-">setAddedBeforeDate</a></span>(org.joda.time.DateTime&nbsp;beforeDate)</code>
<div class="block">Sets the date before which documents should be returned from Sysomos.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html" title="interface in org.apache.streams.sysomos.provider">RequestBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/sysomos/provider/ContentRequestBuilder.html#setHeartBeatId-int-">setHeartBeatId</a></span>(int&nbsp;hid)</code>
<div class="block">Sets the Sysomos Heartbeat ID.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html" title="interface in org.apache.streams.sysomos.provider">RequestBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/sysomos/provider/ContentRequestBuilder.html#setHeartBeatId-java.lang.String-">setHeartBeatId</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;hid)</code>
<div class="block">Sets the Sysomos Heartbeat ID as a String.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html" title="interface in org.apache.streams.sysomos.provider">RequestBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/sysomos/provider/ContentRequestBuilder.html#setOffset-long-">setOffset</a></span>(long&nbsp;offset)</code>
<div class="block">Sets the starting offset for the number of documents given the other parameters.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html" title="interface in org.apache.streams.sysomos.provider">RequestBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/sysomos/provider/ContentRequestBuilder.html#setReturnSetSize-long-">setReturnSetSize</a></span>(long&nbsp;size)</code>
<div class="block">Sets the size of the expected response.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.streams.sysomos.provider.AbstractRequestBuilder">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.streams.sysomos.provider.<a href="../../../../../org/apache/streams/sysomos/provider/AbstractRequestBuilder.html" title="class in org.apache.streams.sysomos.provider">AbstractRequestBuilder</a></h3>
<code><a href="../../../../../org/apache/streams/sysomos/provider/AbstractRequestBuilder.html#execute--">execute</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.streams.sysomos.provider.RequestBuilder">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.streams.sysomos.provider.<a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html" title="interface in org.apache.streams.sysomos.provider">RequestBuilder</a></h3>
<code><a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html#execute--">execute</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="MAX_ALLOWED_PER_REQUEST">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MAX_ALLOWED_PER_REQUEST</h4>
<pre>public static final&nbsp;int MAX_ALLOWED_PER_REQUEST</pre>
<div class="block">The max number of items you are allowed to get per request.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.streams.sysomos.provider.ContentRequestBuilder.MAX_ALLOWED_PER_REQUEST">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ContentRequestBuilder-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ContentRequestBuilder</h4>
<pre>protected&nbsp;ContentRequestBuilder(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;baseUrl,
<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;apiKey)</pre>
<div class="block">Constructs a new ContentRequestBuilder for the specified API key and Sysomos URL.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>baseUrl</code> - the base URL for the sysomos API</dd>
<dd><code>apiKey</code> - the API key generated by Sysomos for authorization</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getRequestUrl--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRequestUrl</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</a>&nbsp;getRequestUrl()</pre>
<div class="block">Gets the Request URL based on the local fields.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html#getRequestUrl--">getRequestUrl</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html" title="interface in org.apache.streams.sysomos.provider">RequestBuilder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a valid URL for the Sysomos API or an exception</dd>
</dl>
</li>
</ul>
<a name="setHeartBeatId-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setHeartBeatId</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html" title="interface in org.apache.streams.sysomos.provider">RequestBuilder</a>&nbsp;setHeartBeatId(int&nbsp;hid)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html#setHeartBeatId-int-">RequestBuilder</a></code></span></div>
<div class="block">Sets the Sysomos Heartbeat ID.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html#setHeartBeatId-int-">setHeartBeatId</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html" title="interface in org.apache.streams.sysomos.provider">RequestBuilder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>hid</code> - Heartbeat ID</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The RequestBuilder for continued Chaining</dd>
</dl>
</li>
</ul>
<a name="setHeartBeatId-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setHeartBeatId</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html" title="interface in org.apache.streams.sysomos.provider">RequestBuilder</a>&nbsp;setHeartBeatId(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;hid)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html#setHeartBeatId-java.lang.String-">RequestBuilder</a></code></span></div>
<div class="block">Sets the Sysomos Heartbeat ID as a String.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html#setHeartBeatId-java.lang.String-">setHeartBeatId</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html" title="interface in org.apache.streams.sysomos.provider">RequestBuilder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>hid</code> - Heartbeat ID string</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The RequestBuilder for continued Chaining</dd>
</dl>
</li>
</ul>
<a name="setAddedAfterDate-org.joda.time.DateTime-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAddedAfterDate</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html" title="interface in org.apache.streams.sysomos.provider">RequestBuilder</a>&nbsp;setAddedAfterDate(org.joda.time.DateTime&nbsp;afterDate)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html#setAddedAfterDate-org.joda.time.DateTime-">RequestBuilder</a></code></span></div>
<div class="block">Sets the date after which documents should be returned from Sysomos.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html#setAddedAfterDate-org.joda.time.DateTime-">setAddedAfterDate</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html" title="interface in org.apache.streams.sysomos.provider">RequestBuilder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>afterDate</code> - the <code>DateTime</code> instance representing the after date</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The RequestBuilder for continued Chaining</dd>
</dl>
</li>
</ul>
<a name="setAddedBeforeDate-org.joda.time.DateTime-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAddedBeforeDate</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html" title="interface in org.apache.streams.sysomos.provider">RequestBuilder</a>&nbsp;setAddedBeforeDate(org.joda.time.DateTime&nbsp;beforeDate)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html#setAddedBeforeDate-org.joda.time.DateTime-">RequestBuilder</a></code></span></div>
<div class="block">Sets the date before which documents should be returned from Sysomos.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html#setAddedBeforeDate-org.joda.time.DateTime-">setAddedBeforeDate</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html" title="interface in org.apache.streams.sysomos.provider">RequestBuilder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>beforeDate</code> - the <code>DateTime</code> instance representing the before date</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The RequestBuilder for continued Chaining</dd>
</dl>
</li>
</ul>
<a name="setReturnSetSize-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setReturnSetSize</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html" title="interface in org.apache.streams.sysomos.provider">RequestBuilder</a>&nbsp;setReturnSetSize(long&nbsp;size)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html#setReturnSetSize-long-">RequestBuilder</a></code></span></div>
<div class="block">Sets the size of the expected response.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html#setReturnSetSize-long-">setReturnSetSize</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html" title="interface in org.apache.streams.sysomos.provider">RequestBuilder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>size</code> - the number of documents</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The RequestBuilder for continued Chaining</dd>
</dl>
</li>
</ul>
<a name="setOffset-long-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setOffset</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html" title="interface in org.apache.streams.sysomos.provider">RequestBuilder</a>&nbsp;setOffset(long&nbsp;offset)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html#setOffset-long-">RequestBuilder</a></code></span></div>
<div class="block">Sets the starting offset for the number of documents given the other parameters.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html#setOffset-long-">setOffset</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html" title="interface in org.apache.streams.sysomos.provider">RequestBuilder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>offset</code> - the starting offset</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The RequestBuilder for continued Chaining</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ContentRequestBuilder.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/streams/sysomos/provider/AbstractRequestBuilder.html" title="class in org.apache.streams.sysomos.provider"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/streams/sysomos/provider/RequestBuilder.html" title="interface in org.apache.streams.sysomos.provider"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/streams/sysomos/provider/ContentRequestBuilder.html" target="_top">Frames</a></li>
<li><a href="ContentRequestBuilder.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2018 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>