| <!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:36 CEST 2018 --> | |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> | |
| <title>Operation (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="Operation (Olingo-OData 4.5.0 API)"; | |
| } | |
| } | |
| catch(err) { | |
| } | |
| //--> | |
| </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/Operation.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/ext/proxy/api/annotations/NavigationProperty.html" title="annotation in org.apache.olingo.ext.proxy.api.annotations"><span class="typeNameLink">Prev Class</span></a></li> | |
| <li><a href="../../../../../../../org/apache/olingo/ext/proxy/api/annotations/Parameter.html" title="annotation in org.apache.olingo.ext.proxy.api.annotations"><span class="typeNameLink">Next Class</span></a></li> | |
| </ul> | |
| <ul class="navList"> | |
| <li><a href="../../../../../../../index.html?org/apache/olingo/ext/proxy/api/annotations/Operation.html" target="_top">Frames</a></li> | |
| <li><a href="Operation.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>Field | </li> | |
| <li><a href="#annotation.type.required.element.summary">Required</a> | </li> | |
| <li><a href="#annotation.type.optional.element.summary">Optional</a></li> | |
| </ul> | |
| <ul class="subNavList"> | |
| <li>Detail: </li> | |
| <li>Field | </li> | |
| <li><a href="#annotation.type.element.detail">Element</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.ext.proxy.api.annotations</div> | |
| <h2 title="Annotation Type Operation" class="title">Annotation Type Operation</h2> | |
| </div> | |
| <div class="contentContainer"> | |
| <div class="description"> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <hr> | |
| <br> | |
| <pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Retention.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>) | |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Target.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/ElementType.html?is-external=true#METHOD" title="class or interface in java.lang.annotation">METHOD</a>) | |
| public @interface <span class="memberNameLabel">Operation</span></pre> | |
| <div class="block">Mark method as EDM function import.</div> | |
| </li> | |
| </ul> | |
| </div> | |
| <div class="summary"> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <!-- =========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY =========== --> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="annotation.type.required.element.summary"> | |
| <!-- --> | |
| </a> | |
| <h3>Required Element Summary</h3> | |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Required Element Summary table, listing required elements, and an explanation"> | |
| <caption><span>Required Elements</span><span class="tabEnd"> </span></caption> | |
| <tr> | |
| <th class="colFirst" scope="col">Modifier and Type</th> | |
| <th class="colLast" scope="col">Required Element and Description</th> | |
| </tr> | |
| <tr 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/ext/proxy/api/annotations/Operation.html#name--">name</a></span></code> </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/olingo/ext/proxy/api/OperationType.html" title="enum in org.apache.olingo.ext.proxy.api">OperationType</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/ext/proxy/api/annotations/Operation.html#type--">type</a></span></code> | |
| <div class="block">Operation type, function or action.</div> | |
| </td> | |
| </tr> | |
| </table> | |
| </li> | |
| </ul> | |
| <!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="annotation.type.optional.element.summary"> | |
| <!-- --> | |
| </a> | |
| <h3>Optional Element Summary</h3> | |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> | |
| <caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> | |
| <tr> | |
| <th class="colFirst" scope="col">Modifier and Type</th> | |
| <th class="colLast" scope="col">Optional Element and Description</th> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><code>boolean</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/ext/proxy/api/annotations/Operation.html#isComposable--">isComposable</a></span></code> | |
| <div class="block">A function element MAY specify a Boolean value for the IsComposable attribute.</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/ext/proxy/api/annotations/Operation.html#referenceType--">referenceType</a></span></code> </td> | |
| </tr> | |
| <tr 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/ext/proxy/api/annotations/Operation.html#returnType--">returnType</a></span></code> | |
| <div class="block">The action/function MAY/MUST specify a return type using the edm:ReturnType element.</div> | |
| </td> | |
| </tr> | |
| </table> | |
| </li> | |
| </ul> | |
| </li> | |
| </ul> | |
| </div> | |
| <div class="details"> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="annotation.type.element.detail"> | |
| <!-- --> | |
| </a> | |
| <h3>Element Detail</h3> | |
| <a name="name--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>name</h4> | |
| <pre>public abstract <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> | |
| </li> | |
| </ul> | |
| </li> | |
| </ul> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="type--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockListLast"> | |
| <li class="blockList"> | |
| <h4>type</h4> | |
| <pre>public abstract <a href="../../../../../../../org/apache/olingo/ext/proxy/api/OperationType.html" title="enum in org.apache.olingo.ext.proxy.api">OperationType</a> type</pre> | |
| <div class="block">Operation type, function or action.</div> | |
| <dl> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>operation type.</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| </li> | |
| </ul> | |
| <!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="referenceType--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>referenceType</h4> | |
| <pre>public abstract <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> referenceType</pre> | |
| <dl> | |
| <dt>Default:</dt> | |
| <dd>java.lang.Void.class</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| </li> | |
| </ul> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="returnType--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>returnType</h4> | |
| <pre>public abstract <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> returnType</pre> | |
| <div class="block">The action/function MAY/MUST specify a return type using the edm:ReturnType element. The return type must be a | |
| scalar, entity or complex type, or a collection of scalar, entity or complex types.</div> | |
| <dl> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>operation return type.</dd> | |
| </dl> | |
| <dl> | |
| <dt>Default:</dt> | |
| <dd>""</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| </li> | |
| </ul> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="isComposable--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockListLast"> | |
| <li class="blockList"> | |
| <h4>isComposable</h4> | |
| <pre>public abstract boolean isComposable</pre> | |
| <div class="block">A function element MAY specify a Boolean value for the IsComposable attribute. If no value is specified for the | |
| IsComposable attribute, the value defaults to false. | |
| <br/> | |
| Functions whose IsComposable attribute is true are considered composable. A composable function can be invoked with | |
| additional path segments or system query options appended to the path that identifies the composable function as | |
| appropriate for the type returned by the composable function.</div> | |
| <dl> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd><tt>TRUE</tt> if is composable; <tt>FALSE</tt> otherwise.</dd> | |
| </dl> | |
| <dl> | |
| <dt>Default:</dt> | |
| <dd>false</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/Operation.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/ext/proxy/api/annotations/NavigationProperty.html" title="annotation in org.apache.olingo.ext.proxy.api.annotations"><span class="typeNameLink">Prev Class</span></a></li> | |
| <li><a href="../../../../../../../org/apache/olingo/ext/proxy/api/annotations/Parameter.html" title="annotation in org.apache.olingo.ext.proxy.api.annotations"><span class="typeNameLink">Next Class</span></a></li> | |
| </ul> | |
| <ul class="navList"> | |
| <li><a href="../../../../../../../index.html?org/apache/olingo/ext/proxy/api/annotations/Operation.html" target="_top">Frames</a></li> | |
| <li><a href="Operation.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>Field | </li> | |
| <li><a href="#annotation.type.required.element.summary">Required</a> | </li> | |
| <li><a href="#annotation.type.optional.element.summary">Optional</a></li> | |
| </ul> | |
| <ul class="subNavList"> | |
| <li>Detail: </li> | |
| <li>Field | </li> | |
| <li><a href="#annotation.type.element.detail">Element</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> |