<!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:31 CEST 2018 --> | |
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> | |
<title>EdmOperation (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="EdmOperation (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}; | |
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/EdmOperation.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/commons/api/edm/EdmNavigationPropertyBinding.html" title="interface in org.apache.olingo.commons.api.edm"><span class="typeNameLink">Prev Class</span></a></li> | |
<li><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmOperationImport.html" title="interface in org.apache.olingo.commons.api.edm"><span class="typeNameLink">Next Class</span></a></li> | |
</ul> | |
<ul class="navList"> | |
<li><a href="../../../../../../index.html?org/apache/olingo/commons/api/edm/EdmOperation.html" target="_top">Frames</a></li> | |
<li><a href="EdmOperation.html" target="_top">No Frames</a></li> | |
</ul> | |
<ul class="navList" id="allclasses_navbar_top"> | |
<li><a href="../../../../../../allclasses-noframe.html">All 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: </li> | |
<li>Nested | </li> | |
<li>Field | </li> | |
<li>Constr | </li> | |
<li><a href="#method.summary">Method</a></li> | |
</ul> | |
<ul class="subNavList"> | |
<li>Detail: </li> | |
<li>Field | </li> | |
<li>Constr | </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.commons.api.edm</div> | |
<h2 title="Interface EdmOperation" class="title">Interface EdmOperation</h2> | |
</div> | |
<div class="contentContainer"> | |
<div class="description"> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<dl> | |
<dt>All Superinterfaces:</dt> | |
<dd><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmAnnotatable.html" title="interface in org.apache.olingo.commons.api.edm">EdmAnnotatable</a>, <a href="../../../../../../org/apache/olingo/commons/api/edm/EdmNamed.html" title="interface in org.apache.olingo.commons.api.edm">EdmNamed</a>, <a href="../../../../../../org/apache/olingo/commons/api/edm/EdmType.html" title="interface in org.apache.olingo.commons.api.edm">EdmType</a></dd> | |
</dl> | |
<dl> | |
<dt>All Known Subinterfaces:</dt> | |
<dd><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmAction.html" title="interface in org.apache.olingo.commons.api.edm">EdmAction</a>, <a href="../../../../../../org/apache/olingo/commons/api/edm/EdmFunction.html" title="interface in org.apache.olingo.commons.api.edm">EdmFunction</a></dd> | |
</dl> | |
<hr> | |
<br> | |
<pre>public interface <span class="typeNameLabel">EdmOperation</span> | |
extends <a href="../../../../../../org/apache/olingo/commons/api/edm/EdmType.html" title="interface in org.apache.olingo.commons.api.edm">EdmType</a>, <a href="../../../../../../org/apache/olingo/commons/api/edm/EdmAnnotatable.html" title="interface in org.apache.olingo.commons.api.edm">EdmAnnotatable</a></pre> | |
<div class="block">A EdmOperation can either be an <a href="../../../../../../org/apache/olingo/commons/api/edm/EdmAction.html" title="interface in org.apache.olingo.commons.api.edm"><code>EdmAction</code></a> or an <a href="../../../../../../org/apache/olingo/commons/api/edm/EdmFunction.html" title="interface in org.apache.olingo.commons.api.edm"><code>EdmFunction</code></a>.</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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </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/commons/api/edm/FullQualifiedName.html" title="class in org.apache.olingo.commons.api.edm">FullQualifiedName</a></code></td> | |
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmOperation.html#getBindingParameterTypeFqn--">getBindingParameterTypeFqn</a></span>()</code> </td> | |
</tr> | |
<tr id="i1" class="rowColor"> | |
<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/commons/api/edm/EdmOperation.html#getEntitySetPath--">getEntitySetPath</a></span>()</code> </td> | |
</tr> | |
<tr id="i2" class="altColor"> | |
<td class="colFirst"><code><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmParameter.html" title="interface in org.apache.olingo.commons.api.edm">EdmParameter</a></code></td> | |
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmOperation.html#getParameter-java.lang.String-">getParameter</a></span>(<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> name)</code> | |
<div class="block">Get parameter for given name</div> | |
</td> | |
</tr> | |
<tr id="i3" class="rowColor"> | |
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<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/commons/api/edm/EdmOperation.html#getParameterNames--">getParameterNames</a></span>()</code> | |
<div class="block">A list of all parameter names.</div> | |
</td> | |
</tr> | |
<tr id="i4" class="altColor"> | |
<td class="colFirst"><code><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmEntitySet.html" title="interface in org.apache.olingo.commons.api.edm">EdmEntitySet</a></code></td> | |
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmOperation.html#getReturnedEntitySet-org.apache.olingo.commons.api.edm.EdmEntitySet-">getReturnedEntitySet</a></span>(<a href="../../../../../../org/apache/olingo/commons/api/edm/EdmEntitySet.html" title="interface in org.apache.olingo.commons.api.edm">EdmEntitySet</a> bindingParameterEntitySet)</code> | |
<div class="block">Get EdmEntitySet for the given binding parameters EntitySet</div> | |
</td> | |
</tr> | |
<tr id="i5" class="rowColor"> | |
<td class="colFirst"><code><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmReturnType.html" title="interface in org.apache.olingo.commons.api.edm">EdmReturnType</a></code></td> | |
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmOperation.html#getReturnType--">getReturnType</a></span>()</code> </td> | |
</tr> | |
<tr id="i6" class="altColor"> | |
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a></code></td> | |
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmOperation.html#isBindingParameterTypeCollection--">isBindingParameterTypeCollection</a></span>()</code> </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/commons/api/edm/EdmOperation.html#isBound--">isBound</a></span>()</code> | |
<div class="block">For more information on bound operations please refer to the OData V4 specification.</div> | |
</td> | |
</tr> | |
</table> | |
<ul class="blockList"> | |
<li class="blockList"><a name="methods.inherited.from.class.org.apache.olingo.commons.api.edm.EdmType"> | |
<!-- --> | |
</a> | |
<h3>Methods inherited from interface org.apache.olingo.commons.api.edm.<a href="../../../../../../org/apache/olingo/commons/api/edm/EdmType.html" title="interface in org.apache.olingo.commons.api.edm">EdmType</a></h3> | |
<code><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmType.html#getFullQualifiedName--">getFullQualifiedName</a>, <a href="../../../../../../org/apache/olingo/commons/api/edm/EdmType.html#getKind--">getKind</a>, <a href="../../../../../../org/apache/olingo/commons/api/edm/EdmType.html#getNamespace--">getNamespace</a></code></li> | |
</ul> | |
<ul class="blockList"> | |
<li class="blockList"><a name="methods.inherited.from.class.org.apache.olingo.commons.api.edm.EdmNamed"> | |
<!-- --> | |
</a> | |
<h3>Methods inherited from interface org.apache.olingo.commons.api.edm.<a href="../../../../../../org/apache/olingo/commons/api/edm/EdmNamed.html" title="interface in org.apache.olingo.commons.api.edm">EdmNamed</a></h3> | |
<code><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmNamed.html#getName--">getName</a></code></li> | |
</ul> | |
<ul class="blockList"> | |
<li class="blockList"><a name="methods.inherited.from.class.org.apache.olingo.commons.api.edm.EdmAnnotatable"> | |
<!-- --> | |
</a> | |
<h3>Methods inherited from interface org.apache.olingo.commons.api.edm.<a href="../../../../../../org/apache/olingo/commons/api/edm/EdmAnnotatable.html" title="interface in org.apache.olingo.commons.api.edm">EdmAnnotatable</a></h3> | |
<code><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmAnnotatable.html#getAnnotation-org.apache.olingo.commons.api.edm.EdmTerm-java.lang.String-">getAnnotation</a>, <a href="../../../../../../org/apache/olingo/commons/api/edm/EdmAnnotatable.html#getAnnotations--">getAnnotations</a></code></li> | |
</ul> | |
</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="getParameter-java.lang.String-"> | |
<!-- --> | |
</a> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<h4>getParameter</h4> | |
<pre><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmParameter.html" title="interface in org.apache.olingo.commons.api.edm">EdmParameter</a> getParameter(<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> name)</pre> | |
<div class="block">Get parameter for given name</div> | |
<dl> | |
<dt><span class="paramLabel">Parameters:</span></dt> | |
<dd><code>name</code> - name of parameter</dd> | |
<dt><span class="returnLabel">Returns:</span></dt> | |
<dd><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmParameter.html" title="interface in org.apache.olingo.commons.api.edm"><code>EdmParameter</code></a> for this name</dd> | |
</dl> | |
</li> | |
</ul> | |
<a name="getParameterNames--"> | |
<!-- --> | |
</a> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<h4>getParameterNames</h4> | |
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<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>> getParameterNames()</pre> | |
<div class="block">A list of all parameter names. If this is a bound action or function the first parameter name in the list is the | |
binding parameter</div> | |
<dl> | |
<dt><span class="returnLabel">Returns:</span></dt> | |
<dd>a list of all parameter names</dd> | |
</dl> | |
</li> | |
</ul> | |
<a name="getReturnedEntitySet-org.apache.olingo.commons.api.edm.EdmEntitySet-"> | |
<!-- --> | |
</a> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<h4>getReturnedEntitySet</h4> | |
<pre><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmEntitySet.html" title="interface in org.apache.olingo.commons.api.edm">EdmEntitySet</a> getReturnedEntitySet(<a href="../../../../../../org/apache/olingo/commons/api/edm/EdmEntitySet.html" title="interface in org.apache.olingo.commons.api.edm">EdmEntitySet</a> bindingParameterEntitySet)</pre> | |
<div class="block">Get EdmEntitySet for the given binding parameters EntitySet</div> | |
<dl> | |
<dt><span class="paramLabel">Parameters:</span></dt> | |
<dd><code>bindingParameterEntitySet</code> - EntitySet of binding parameter</dd> | |
<dt><span class="returnLabel">Returns:</span></dt> | |
<dd><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmEntitySet.html" title="interface in org.apache.olingo.commons.api.edm"><code>EdmEntitySet</code></a> for this binding</dd> | |
</dl> | |
</li> | |
</ul> | |
<a name="getReturnType--"> | |
<!-- --> | |
</a> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<h4>getReturnType</h4> | |
<pre><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmReturnType.html" title="interface in org.apache.olingo.commons.api.edm">EdmReturnType</a> getReturnType()</pre> | |
<dl> | |
<dt><span class="returnLabel">Returns:</span></dt> | |
<dd><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmReturnType.html" title="interface in org.apache.olingo.commons.api.edm"><code>EdmReturnType</code></a> of this operation</dd> | |
</dl> | |
</li> | |
</ul> | |
<a name="isBound--"> | |
<!-- --> | |
</a> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<h4>isBound</h4> | |
<pre>boolean isBound()</pre> | |
<div class="block">For more information on bound operations please refer to the OData V4 specification.</div> | |
<dl> | |
<dt><span class="returnLabel">Returns:</span></dt> | |
<dd>true if bound</dd> | |
</dl> | |
</li> | |
</ul> | |
<a name="getBindingParameterTypeFqn--"> | |
<!-- --> | |
</a> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<h4>getBindingParameterTypeFqn</h4> | |
<pre><a href="../../../../../../org/apache/olingo/commons/api/edm/FullQualifiedName.html" title="class in org.apache.olingo.commons.api.edm">FullQualifiedName</a> getBindingParameterTypeFqn()</pre> | |
<dl> | |
<dt><span class="returnLabel">Returns:</span></dt> | |
<dd>the fullqualified type name of the binding parameter</dd> | |
</dl> | |
</li> | |
</ul> | |
<a name="isBindingParameterTypeCollection--"> | |
<!-- --> | |
</a> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<h4>isBindingParameterTypeCollection</h4> | |
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> isBindingParameterTypeCollection()</pre> | |
<dl> | |
<dt><span class="returnLabel">Returns:</span></dt> | |
<dd>true if binding parameter is of type collection.</dd> | |
</dl> | |
</li> | |
</ul> | |
<a name="getEntitySetPath--"> | |
<!-- --> | |
</a> | |
<ul class="blockListLast"> | |
<li class="blockList"> | |
<h4>getEntitySetPath</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> getEntitySetPath()</pre> | |
<dl> | |
<dt><span class="returnLabel">Returns:</span></dt> | |
<dd>the entity set path as a String or null if not present</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/EdmOperation.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/commons/api/edm/EdmNavigationPropertyBinding.html" title="interface in org.apache.olingo.commons.api.edm"><span class="typeNameLink">Prev Class</span></a></li> | |
<li><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmOperationImport.html" title="interface in org.apache.olingo.commons.api.edm"><span class="typeNameLink">Next Class</span></a></li> | |
</ul> | |
<ul class="navList"> | |
<li><a href="../../../../../../index.html?org/apache/olingo/commons/api/edm/EdmOperation.html" target="_top">Frames</a></li> | |
<li><a href="EdmOperation.html" target="_top">No Frames</a></li> | |
</ul> | |
<ul class="navList" id="allclasses_navbar_bottom"> | |
<li><a href="../../../../../../allclasses-noframe.html">All 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: </li> | |
<li>Nested | </li> | |
<li>Field | </li> | |
<li>Constr | </li> | |
<li><a href="#method.summary">Method</a></li> | |
</ul> | |
<ul class="subNavList"> | |
<li>Detail: </li> | |
<li>Field | </li> | |
<li>Constr | </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 © 2013–2018 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> | |
</body> | |
</html> |