blob: 32bf51253f0a3abef3dad42d19ce336527776e4a [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_92) on Mon Aug 13 15:36:35 CEST 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ExpandItem (Olingo-OData 4.5.0 API)</title>
<meta name="date" content="2018-08-13">
<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="ExpandItem (Olingo-OData 4.5.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/ExpandItem.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/olingo/server/api/uri/queryoption/DeltaTokenOption.html" title="interface in org.apache.olingo.server.api.uri.queryoption"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/ExpandOption.html" title="interface in org.apache.olingo.server.api.uri.queryoption"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/olingo/server/api/uri/queryoption/ExpandItem.html" target="_top">Frames</a></li>
<li><a href="ExpandItem.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>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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.olingo.server.api.uri.queryoption</div>
<h2 title="Interface ExpandItem" class="title">Interface ExpandItem</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">ExpandItem</span></pre>
<div class="block">Represents a single resource path which should be expanded with using the system query option $expand
For example: http://.../entitySet?$expand=Products($filter=DiscontinuedDate eq null)</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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="../../../../../../../org/apache/olingo/server/api/uri/queryoption/ApplyOption.html" title="interface in org.apache.olingo.server.api.uri.queryoption">ApplyOption</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/ExpandItem.html#getApplyOption--">getApplyOption</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/CountOption.html" title="interface in org.apache.olingo.server.api.uri.queryoption">CountOption</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/ExpandItem.html#getCountOption--">getCountOption</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/ExpandOption.html" title="interface in org.apache.olingo.server.api.uri.queryoption">ExpandOption</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/ExpandItem.html#getExpandOption--">getExpandOption</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/FilterOption.html" title="interface in org.apache.olingo.server.api.uri.queryoption">FilterOption</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/ExpandItem.html#getFilterOption--">getFilterOption</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/LevelsExpandOption.html" title="interface in org.apache.olingo.server.api.uri.queryoption">LevelsExpandOption</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/ExpandItem.html#getLevelsOption--">getLevelsOption</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/OrderByOption.html" title="interface in org.apache.olingo.server.api.uri.queryoption">OrderByOption</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/ExpandItem.html#getOrderByOption--">getOrderByOption</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/olingo/server/api/uri/UriInfoResource.html" title="interface in org.apache.olingo.server.api.uri">UriInfoResource</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/ExpandItem.html#getResourcePath--">getResourcePath</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/SearchOption.html" title="interface in org.apache.olingo.server.api.uri.queryoption">SearchOption</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/ExpandItem.html#getSearchOption--">getSearchOption</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/SelectOption.html" title="interface in org.apache.olingo.server.api.uri.queryoption">SelectOption</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/ExpandItem.html#getSelectOption--">getSelectOption</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/SkipOption.html" title="interface in org.apache.olingo.server.api.uri.queryoption">SkipOption</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/ExpandItem.html#getSkipOption--">getSkipOption</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/olingo/commons/api/edm/EdmType.html" title="interface in org.apache.olingo.commons.api.edm">EdmType</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/ExpandItem.html#getStartTypeFilter--">getStartTypeFilter</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/TopOption.html" title="interface in org.apache.olingo.server.api.uri.queryoption">TopOption</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/ExpandItem.html#getTopOption--">getTopOption</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/ExpandItem.html#hasCountPath--">hasCountPath</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/ExpandItem.html#isRef--">isRef</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/ExpandItem.html#isStar--">isStar</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getLevelsOption--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLevelsOption</h4>
<pre><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/LevelsExpandOption.html" title="interface in org.apache.olingo.server.api.uri.queryoption">LevelsExpandOption</a>&nbsp;getLevelsOption()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Information of the option $level when used within $expand</dd>
</dl>
</li>
</ul>
<a name="getFilterOption--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFilterOption</h4>
<pre><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/FilterOption.html" title="interface in org.apache.olingo.server.api.uri.queryoption">FilterOption</a>&nbsp;getFilterOption()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Information of the option $filter when used within $expand</dd>
</dl>
</li>
</ul>
<a name="getSearchOption--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSearchOption</h4>
<pre><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/SearchOption.html" title="interface in org.apache.olingo.server.api.uri.queryoption">SearchOption</a>&nbsp;getSearchOption()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Information of the option $search when used within $expand</dd>
</dl>
</li>
</ul>
<a name="getOrderByOption--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOrderByOption</h4>
<pre><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/OrderByOption.html" title="interface in org.apache.olingo.server.api.uri.queryoption">OrderByOption</a>&nbsp;getOrderByOption()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Information of the option $orderby when used within $expand</dd>
</dl>
</li>
</ul>
<a name="getSkipOption--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSkipOption</h4>
<pre><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/SkipOption.html" title="interface in org.apache.olingo.server.api.uri.queryoption">SkipOption</a>&nbsp;getSkipOption()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Information of the option $skip when used within $expand</dd>
</dl>
</li>
</ul>
<a name="getTopOption--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTopOption</h4>
<pre><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/TopOption.html" title="interface in org.apache.olingo.server.api.uri.queryoption">TopOption</a>&nbsp;getTopOption()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Information of the option $top when used within $expand</dd>
</dl>
</li>
</ul>
<a name="getCountOption--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCountOption</h4>
<pre><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/CountOption.html" title="interface in org.apache.olingo.server.api.uri.queryoption">CountOption</a>&nbsp;getCountOption()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Information of the option $count when used within $expand</dd>
</dl>
</li>
</ul>
<a name="getSelectOption--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSelectOption</h4>
<pre><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/SelectOption.html" title="interface in org.apache.olingo.server.api.uri.queryoption">SelectOption</a>&nbsp;getSelectOption()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Information of the option $select when used within $expand</dd>
</dl>
</li>
</ul>
<a name="getExpandOption--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExpandOption</h4>
<pre><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/ExpandOption.html" title="interface in org.apache.olingo.server.api.uri.queryoption">ExpandOption</a>&nbsp;getExpandOption()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Information of the option $expand when used within $expand</dd>
</dl>
</li>
</ul>
<a name="getApplyOption--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getApplyOption</h4>
<pre><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/ApplyOption.html" title="interface in org.apache.olingo.server.api.uri.queryoption">ApplyOption</a>&nbsp;getApplyOption()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Information on the option $apply when used within $expand</dd>
</dl>
</li>
</ul>
<a name="getResourcePath--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResourcePath</h4>
<pre><a href="../../../../../../../org/apache/olingo/server/api/uri/UriInfoResource.html" title="interface in org.apache.olingo.server.api.uri">UriInfoResource</a>&nbsp;getResourcePath()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A <a href="../../../../../../../org/apache/olingo/server/api/uri/UriInfoResource.html" title="interface in org.apache.olingo.server.api.uri"><code>UriInfoResource</code></a> object containing the resource path segments to be expanded</dd>
</dl>
</li>
</ul>
<a name="isStar--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isStar</h4>
<pre>boolean&nbsp;isStar()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A star is used within $expand.
For example: ...?$expand=*</dd>
</dl>
</li>
</ul>
<a name="isRef--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isRef</h4>
<pre>boolean&nbsp;isRef()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A $ref is used within $expand.
For example: ...?$expand=navigation/$ref</dd>
</dl>
</li>
</ul>
<a name="hasCountPath--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasCountPath</h4>
<pre>boolean&nbsp;hasCountPath()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A $count is used within $expand.
For example: ...?$expand=navigation/$count</dd>
</dl>
</li>
</ul>
<a name="getStartTypeFilter--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getStartTypeFilter</h4>
<pre><a href="../../../../../../../org/apache/olingo/commons/api/edm/EdmType.html" title="interface in org.apache.olingo.commons.api.edm">EdmType</a>&nbsp;getStartTypeFilter()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Before resource path segments which should be expanded a type filter may be used.
For example: ...persons?$expand=namespace.managertype/team</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/ExpandItem.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/olingo/server/api/uri/queryoption/DeltaTokenOption.html" title="interface in org.apache.olingo.server.api.uri.queryoption"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/ExpandOption.html" title="interface in org.apache.olingo.server.api.uri.queryoption"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/olingo/server/api/uri/queryoption/ExpandItem.html" target="_top">Frames</a></li>
<li><a href="ExpandItem.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>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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; 2013&#x2013;2018 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>