blob: 67b20a54f6f35b2ca4203770978c21f0461119f2 [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:34 CEST 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ClientValue (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="ClientValue (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};
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/ClientValue.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/client/api/domain/ClientValuable.html" title="interface in org.apache.olingo.client.api.domain"><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/client/api/domain/ClientValue.html" target="_top">Frames</a></li>
<li><a href="ClientValue.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.client.api.domain</div>
<h2 title="Interface ClientValue" class="title">Interface ClientValue</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../../../org/apache/olingo/client/api/domain/ClientCollectionValue.html" title="interface in org.apache.olingo.client.api.domain">ClientCollectionValue</a>&lt;T&gt;, <a href="../../../../../../org/apache/olingo/client/api/domain/ClientComplexValue.html" title="interface in org.apache.olingo.client.api.domain">ClientComplexValue</a>, <a href="../../../../../../org/apache/olingo/client/api/domain/ClientEnumValue.html" title="interface in org.apache.olingo.client.api.domain">ClientEnumValue</a>, <a href="../../../../../../org/apache/olingo/client/api/domain/ClientPrimitiveValue.html" title="interface in org.apache.olingo.client.api.domain">ClientPrimitiveValue</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../org/apache/olingo/client/api/domain/AbstractClientValue.html" title="class in org.apache.olingo.client.api.domain">AbstractClientValue</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">ClientValue</span></pre>
<div class="block">Abstract representation of an OData entity property value.</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>&lt;T extends <a href="../../../../../../org/apache/olingo/client/api/domain/ClientValue.html" title="interface in org.apache.olingo.client.api.domain">ClientValue</a>&gt;<br><a href="../../../../../../org/apache/olingo/client/api/domain/ClientCollectionValue.html" title="interface in org.apache.olingo.client.api.domain">ClientCollectionValue</a>&lt;T&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/client/api/domain/ClientValue.html#asCollection--">asCollection</a></span>()</code>
<div class="block">Casts to collection value.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/olingo/client/api/domain/ClientComplexValue.html" title="interface in org.apache.olingo.client.api.domain">ClientComplexValue</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/client/api/domain/ClientValue.html#asComplex--">asComplex</a></span>()</code>
<div class="block">Casts to complex value.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/olingo/client/api/domain/ClientEnumValue.html" title="interface in org.apache.olingo.client.api.domain">ClientEnumValue</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/client/api/domain/ClientValue.html#asEnum--">asEnum</a></span>()</code>
<div class="block">Casts to enum value.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/olingo/client/api/domain/ClientPrimitiveValue.html" title="interface in org.apache.olingo.client.api.domain">ClientPrimitiveValue</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/client/api/domain/ClientValue.html#asPrimitive--">asPrimitive</a></span>()</code>
<div class="block">Casts to primitive value.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/client/api/domain/ClientValue.html#getTypeName--">getTypeName</a></span>()</code>
<div class="block">Gets value type name.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/client/api/domain/ClientValue.html#isCollection--">isCollection</a></span>()</code>
<div class="block">Check is is a collection value.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/client/api/domain/ClientValue.html#isComplex--">isComplex</a></span>()</code>
<div class="block">Check is is a linked complex value.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/client/api/domain/ClientValue.html#isEnum--">isEnum</a></span>()</code>
<div class="block">Check is is an enum value.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/client/api/domain/ClientValue.html#isPrimitive--">isPrimitive</a></span>()</code>
<div class="block">Check is is a primitive value.</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="getTypeName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTypeName</h4>
<pre><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>&nbsp;getTypeName()</pre>
<div class="block">Gets value type name.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>value type name.</dd>
</dl>
</li>
</ul>
<a name="isPrimitive--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isPrimitive</h4>
<pre>boolean&nbsp;isPrimitive()</pre>
<div class="block">Check is is a primitive value.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>'TRUE' if primitive; 'FALSE' otherwise.</dd>
</dl>
</li>
</ul>
<a name="asPrimitive--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>asPrimitive</h4>
<pre><a href="../../../../../../org/apache/olingo/client/api/domain/ClientPrimitiveValue.html" title="interface in org.apache.olingo.client.api.domain">ClientPrimitiveValue</a>&nbsp;asPrimitive()</pre>
<div class="block">Casts to primitive value.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>primitive value.</dd>
</dl>
</li>
</ul>
<a name="isCollection--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCollection</h4>
<pre>boolean&nbsp;isCollection()</pre>
<div class="block">Check is is a collection value.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>'TRUE' if collection; 'FALSE' otherwise.</dd>
</dl>
</li>
</ul>
<a name="asCollection--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>asCollection</h4>
<pre>&lt;T extends <a href="../../../../../../org/apache/olingo/client/api/domain/ClientValue.html" title="interface in org.apache.olingo.client.api.domain">ClientValue</a>&gt;&nbsp;<a href="../../../../../../org/apache/olingo/client/api/domain/ClientCollectionValue.html" title="interface in org.apache.olingo.client.api.domain">ClientCollectionValue</a>&lt;T&gt;&nbsp;asCollection()</pre>
<div class="block">Casts to collection value.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - The actual ODataValue interface.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>collection value.</dd>
</dl>
</li>
</ul>
<a name="asComplex--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>asComplex</h4>
<pre><a href="../../../../../../org/apache/olingo/client/api/domain/ClientComplexValue.html" title="interface in org.apache.olingo.client.api.domain">ClientComplexValue</a>&nbsp;asComplex()</pre>
<div class="block">Casts to complex value.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>complex value.</dd>
</dl>
</li>
</ul>
<a name="isComplex--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isComplex</h4>
<pre>boolean&nbsp;isComplex()</pre>
<div class="block">Check is is a linked complex value.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>'TRUE' if linked complex; 'FALSE' otherwise.</dd>
</dl>
</li>
</ul>
<a name="isEnum--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEnum</h4>
<pre>boolean&nbsp;isEnum()</pre>
<div class="block">Check is is an enum value.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>'TRUE' if enum; 'FALSE' otherwise.</dd>
</dl>
</li>
</ul>
<a name="asEnum--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>asEnum</h4>
<pre><a href="../../../../../../org/apache/olingo/client/api/domain/ClientEnumValue.html" title="interface in org.apache.olingo.client.api.domain">ClientEnumValue</a>&nbsp;asEnum()</pre>
<div class="block">Casts to enum value.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>enum value.</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/ClientValue.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/client/api/domain/ClientValuable.html" title="interface in org.apache.olingo.client.api.domain"><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/client/api/domain/ClientValue.html" target="_top">Frames</a></li>
<li><a href="ClientValue.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>