blob: c6dfaa70a0350d08145e9f2482a6522bc87b753e [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 Wed Dec 06 14:36:21 CET 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ODataEntry (olingo-odata2-parent 2.0.10 API)</title>
<meta name="date" content="2017-12-06">
<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="ODataEntry (olingo-odata2-parent 2.0.10 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":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/ODataEntry.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/odata2/api/ep/entry/MediaMetadata.html" title="interface in org.apache.olingo.odata2.api.ep.entry"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/olingo/odata2/api/ep/entry/ODataEntry.html" target="_top">Frames</a></li>
<li><a href="ODataEntry.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.odata2.api.ep.entry</div>
<h2 title="Interface ODataEntry" class="title">Interface ODataEntry</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">ODataEntry</span></pre>
<div class="block">An <a href="../../../../../../../org/apache/olingo/odata2/api/ep/entry/ODataEntry.html" title="interface in org.apache.olingo.odata2.api.ep.entry"><code>ODataEntry</code></a> contains all <b>properties</b> (in form of a <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a>) and possible <b>metadata</b>
(in form of <a href="../../../../../../../org/apache/olingo/odata2/api/ep/entry/MediaMetadata.html" title="interface in org.apache.olingo.odata2.api.ep.entry"><code>MediaMetadata</code></a> and/or <a href="../../../../../../../org/apache/olingo/odata2/api/ep/entry/EntryMetadata.html" title="interface in org.apache.olingo.odata2.api.ep.entry"><code>EntryMetadata</code></a>) for an entry.</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>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/odata2/api/ep/entry/ODataEntry.html#containsInlineEntry--">containsInlineEntry</a></span>()</code>
<div class="block">If this <a href="../../../../../../../org/apache/olingo/odata2/api/ep/entry/ODataEntry.html" title="interface in org.apache.olingo.odata2.api.ep.entry"><code>ODataEntry</code></a> contains properties of an inline navigation property this method
returns <code>true</code>.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/olingo/odata2/api/uri/ExpandSelectTreeNode.html" title="class in org.apache.olingo.odata2.api.uri">ExpandSelectTreeNode</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/odata2/api/ep/entry/ODataEntry.html#getExpandSelectTree--">getExpandSelectTree</a></span>()</code>
<div class="block">Gets the expand select tree data structure which can be used for <code>$expand</code> query option.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/olingo/odata2/api/ep/entry/MediaMetadata.html" title="interface in org.apache.olingo.odata2.api.ep.entry">MediaMetadata</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/odata2/api/ep/entry/ODataEntry.html#getMediaMetadata--">getMediaMetadata</a></span>()</code>
<div class="block">Get <a href="../../../../../../../org/apache/olingo/odata2/api/ep/entry/MediaMetadata.html" title="interface in org.apache.olingo.odata2.api.ep.entry"><code>MediaMetadata</code></a> for this <a href="../../../../../../../org/apache/olingo/odata2/api/ep/entry/ODataEntry.html" title="interface in org.apache.olingo.odata2.api.ep.entry"><code>ODataEntry</code></a> if available.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/olingo/odata2/api/ep/entry/EntryMetadata.html" title="interface in org.apache.olingo.odata2.api.ep.entry">EntryMetadata</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/odata2/api/ep/entry/ODataEntry.html#getMetadata--">getMetadata</a></span>()</code>
<div class="block">Get <a href="../../../../../../../org/apache/olingo/odata2/api/ep/entry/EntryMetadata.html" title="interface in org.apache.olingo.odata2.api.ep.entry"><code>EntryMetadata</code></a> for this <a href="../../../../../../../org/apache/olingo/odata2/api/ep/entry/ODataEntry.html" title="interface in org.apache.olingo.odata2.api.ep.entry"><code>ODataEntry</code></a> if available.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/odata2/api/ep/entry/ODataEntry.html#getProperties--">getProperties</a></span>()</code>
<div class="block">Properties of this <a href="../../../../../../../org/apache/olingo/odata2/api/ep/entry/ODataEntry.html" title="interface in org.apache.olingo.odata2.api.ep.entry"><code>ODataEntry</code></a> in form of a <b>property name</b> to <b>property value</b> map.</div>
</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="getProperties--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProperties</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;getProperties()</pre>
<div class="block">Properties of this <a href="../../../../../../../org/apache/olingo/odata2/api/ep/entry/ODataEntry.html" title="interface in org.apache.olingo.odata2.api.ep.entry"><code>ODataEntry</code></a> in form of a <b>property name</b> to <b>property value</b> map.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <b>property name</b> to <b>property value</b> map.</dd>
</dl>
</li>
</ul>
<a name="getMediaMetadata--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMediaMetadata</h4>
<pre><a href="../../../../../../../org/apache/olingo/odata2/api/ep/entry/MediaMetadata.html" title="interface in org.apache.olingo.odata2.api.ep.entry">MediaMetadata</a>&nbsp;getMediaMetadata()</pre>
<div class="block">Get <a href="../../../../../../../org/apache/olingo/odata2/api/ep/entry/MediaMetadata.html" title="interface in org.apache.olingo.odata2.api.ep.entry"><code>MediaMetadata</code></a> for this <a href="../../../../../../../org/apache/olingo/odata2/api/ep/entry/ODataEntry.html" title="interface in org.apache.olingo.odata2.api.ep.entry"><code>ODataEntry</code></a> if available.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="../../../../../../../org/apache/olingo/odata2/api/ep/entry/MediaMetadata.html" title="interface in org.apache.olingo.odata2.api.ep.entry"><code>MediaMetadata</code></a> for this <a href="../../../../../../../org/apache/olingo/odata2/api/ep/entry/ODataEntry.html" title="interface in org.apache.olingo.odata2.api.ep.entry"><code>ODataEntry</code></a> if available.</dd>
</dl>
</li>
</ul>
<a name="getMetadata--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMetadata</h4>
<pre><a href="../../../../../../../org/apache/olingo/odata2/api/ep/entry/EntryMetadata.html" title="interface in org.apache.olingo.odata2.api.ep.entry">EntryMetadata</a>&nbsp;getMetadata()</pre>
<div class="block">Get <a href="../../../../../../../org/apache/olingo/odata2/api/ep/entry/EntryMetadata.html" title="interface in org.apache.olingo.odata2.api.ep.entry"><code>EntryMetadata</code></a> for this <a href="../../../../../../../org/apache/olingo/odata2/api/ep/entry/ODataEntry.html" title="interface in org.apache.olingo.odata2.api.ep.entry"><code>ODataEntry</code></a> if available.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="../../../../../../../org/apache/olingo/odata2/api/ep/entry/EntryMetadata.html" title="interface in org.apache.olingo.odata2.api.ep.entry"><code>EntryMetadata</code></a> for this <a href="../../../../../../../org/apache/olingo/odata2/api/ep/entry/ODataEntry.html" title="interface in org.apache.olingo.odata2.api.ep.entry"><code>ODataEntry</code></a> if available.</dd>
</dl>
</li>
</ul>
<a name="containsInlineEntry--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>containsInlineEntry</h4>
<pre>boolean&nbsp;containsInlineEntry()</pre>
<div class="block">If this <a href="../../../../../../../org/apache/olingo/odata2/api/ep/entry/ODataEntry.html" title="interface in org.apache.olingo.odata2.api.ep.entry"><code>ODataEntry</code></a> contains properties of an inline navigation property this method
returns <code>true</code>.
Otherwise if this <a href="../../../../../../../org/apache/olingo/odata2/api/ep/entry/ODataEntry.html" title="interface in org.apache.olingo.odata2.api.ep.entry"><code>ODataEntry</code></a> only contains it own properties this method
returns <code>false</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if inline navigation properties are contained, otherwise <code>false</code>.</dd>
</dl>
</li>
</ul>
<a name="getExpandSelectTree--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getExpandSelectTree</h4>
<pre><a href="../../../../../../../org/apache/olingo/odata2/api/uri/ExpandSelectTreeNode.html" title="class in org.apache.olingo.odata2.api.uri">ExpandSelectTreeNode</a>&nbsp;getExpandSelectTree()</pre>
<div class="block">Gets the expand select tree data structure which can be used for <code>$expand</code> query option.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>parsed tree structure representing the $expand</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/ODataEntry.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/odata2/api/ep/entry/MediaMetadata.html" title="interface in org.apache.olingo.odata2.api.ep.entry"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/olingo/odata2/api/ep/entry/ODataEntry.html" target="_top">Frames</a></li>
<li><a href="ODataEntry.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-2017 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>