| <!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:22 CET 2017 --> | |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> | |
| <title>EdmProperty (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="EdmProperty (olingo-odata2-parent 2.0.10 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/EdmProperty.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/annotation/edm/EdmNavigationProperty.Multiplicity.html" title="enum in org.apache.olingo.odata2.api.annotation.edm"><span class="typeNameLink">Prev Class</span></a></li> | |
| <li><a href="../../../../../../../org/apache/olingo/odata2/api/annotation/edm/EdmType.html" title="enum in org.apache.olingo.odata2.api.annotation.edm"><span class="typeNameLink">Next Class</span></a></li> | |
| </ul> | |
| <ul class="navList"> | |
| <li><a href="../../../../../../../index.html?org/apache/olingo/odata2/api/annotation/edm/EdmProperty.html" target="_top">Frames</a></li> | |
| <li><a href="EdmProperty.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>Required | </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.odata2.api.annotation.edm</div> | |
| <h2 title="Annotation Type EdmProperty" class="title">Annotation Type EdmProperty</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#FIELD" title="class or interface in java.lang.annotation">FIELD</a>) | |
| public @interface <span class="memberNameLabel">EdmProperty</span></pre> | |
| <div class="block"><p>Annotation for definition of an EdmProperty for an EdmEntityType or EdmComplexType | |
| which contains the EdmProperty as a field.</p> | |
| The EdmProperty annotation has to be used on a field within a EdmEntityType or EdmComplexType annotated class.</div> | |
| </li> | |
| </ul> | |
| </div> | |
| <div class="summary"> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <!-- =========== 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><a href="../../../../../../../org/apache/olingo/odata2/api/annotation/edm/EdmFacets.html" title="annotation in org.apache.olingo.odata2.api.annotation.edm">EdmFacets</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/odata2/api/annotation/edm/EdmProperty.html#facets--">facets</a></span></code> | |
| <div class="block">Define the EdmFacets for the Property in the EDM.</div> | |
| </td> | |
| </tr> | |
| <tr 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/odata2/api/annotation/edm/EdmProperty.html#name--">name</a></span></code> | |
| <div class="block">Define the name for the Property.</div> | |
| </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/olingo/odata2/api/annotation/edm/EdmType.html" title="enum in org.apache.olingo.odata2.api.annotation.edm">EdmType</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/odata2/api/annotation/edm/EdmProperty.html#type--">type</a></span></code> | |
| <div class="block">Define the EdmSimpleType which is used for the Property in the EDM.</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="type--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>type</h4> | |
| <pre>public abstract <a href="../../../../../../../org/apache/olingo/odata2/api/annotation/edm/EdmType.html" title="enum in org.apache.olingo.odata2.api.annotation.edm">EdmType</a> type</pre> | |
| <div class="block">Define the EdmSimpleType which is used for the Property in the EDM. | |
| <p> | |
| If not explicit set a default value has to be generated by the EDM provider (which should be compatible to the | |
| java type of the annotated field). | |
| <p> | |
| If the property is a simple property a EdmSimpleType must be used which can be mapped to the | |
| java type of the annotated field. Which mappings are available depends on the used implementation. | |
| <p> | |
| If the property is a EdmComplexType (and no EdmSimpleType) the type <code>COMPLEX</code> must be used.</div> | |
| <dl> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>type for the Property as used in the EDM</dd> | |
| </dl> | |
| <dl> | |
| <dt>Default:</dt> | |
| <dd>org.apache.olingo.odata2.api.annotation.edm.EdmType.NULL</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| </li> | |
| </ul> | |
| <ul class="blockList"> | |
| <li class="blockList"><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> | |
| <div class="block">Define the name for the Property. | |
| If not set a default value has to be generated by the EDM provider.</div> | |
| <dl> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>name for the Property</dd> | |
| </dl> | |
| <dl> | |
| <dt>Default:</dt> | |
| <dd>""</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| </li> | |
| </ul> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="facets--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockListLast"> | |
| <li class="blockList"> | |
| <h4>facets</h4> | |
| <pre>public abstract <a href="../../../../../../../org/apache/olingo/odata2/api/annotation/edm/EdmFacets.html" title="annotation in org.apache.olingo.odata2.api.annotation.edm">EdmFacets</a> facets</pre> | |
| <div class="block">Define the EdmFacets for the Property in the EDM. | |
| If not set the default EdmFacet values are used (see <a href="../../../../../../../org/apache/olingo/odata2/api/annotation/edm/EdmFacets.html" title="annotation in org.apache.olingo.odata2.api.annotation.edm"><code>EdmFacets</code></a>).</div> | |
| <dl> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>facets for the Property as used in the EDM</dd> | |
| </dl> | |
| <dl> | |
| <dt>Default:</dt> | |
| <dd>@org.apache.olingo.odata2.api.annotation.edm.EdmFacets</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/EdmProperty.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/annotation/edm/EdmNavigationProperty.Multiplicity.html" title="enum in org.apache.olingo.odata2.api.annotation.edm"><span class="typeNameLink">Prev Class</span></a></li> | |
| <li><a href="../../../../../../../org/apache/olingo/odata2/api/annotation/edm/EdmType.html" title="enum in org.apache.olingo.odata2.api.annotation.edm"><span class="typeNameLink">Next Class</span></a></li> | |
| </ul> | |
| <ul class="navList"> | |
| <li><a href="../../../../../../../index.html?org/apache/olingo/odata2/api/annotation/edm/EdmProperty.html" target="_top">Frames</a></li> | |
| <li><a href="EdmProperty.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>Required | </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-2017 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> | |
| </body> | |
| </html> |