blob: b236b16b956fde681fcb8b64a2b46f6401452a47 [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:23 CET 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.apache.olingo.odata2.api.annotation.edm (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="org.apache.olingo.odata2.api.annotation.edm (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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../../org/apache/olingo/odata2/api/batch/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/olingo/odata2/api/annotation/edm/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.olingo.odata2.api.annotation.edm</h1>
<div class="docSummary">
<div class="block">Annotations-API for Entity Data Model definition</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/olingo/odata2/api/annotation/edm/EdmFunctionImport.HttpMethod.html" title="enum in org.apache.olingo.odata2.api.annotation.edm">EdmFunctionImport.HttpMethod</a></td>
<td class="colLast">
<div class="block">Concrete HttpMethods for a function import as specified in OData.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/olingo/odata2/api/annotation/edm/EdmFunctionImport.ReturnType.Type.html" title="enum in org.apache.olingo.odata2.api.annotation.edm">EdmFunctionImport.ReturnType.Type</a></td>
<td class="colLast">
<div class="block">Concrete return types as specified in OData.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/olingo/odata2/api/annotation/edm/EdmNavigationProperty.Multiplicity.html" title="enum in org.apache.olingo.odata2.api.annotation.edm">EdmNavigationProperty.Multiplicity</a></td>
<td class="colLast">
<div class="block">EdmMultiplicity indicates the number of entity type instances
an association end can relate to:
ZERO_OR_ONE (0..1)value is exactly one but can be null (i.e.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/olingo/odata2/api/annotation/edm/EdmType.html" title="enum in org.apache.olingo.odata2.api.annotation.edm">EdmType</a></td>
<td class="colLast">
<div class="block">The EdmTypes which can be used for property definition in the EDM.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Annotation Types Summary table, listing annotation types, and an explanation">
<caption><span>Annotation Types Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Annotation Type</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/olingo/odata2/api/annotation/edm/EdmComplexType.html" title="annotation in org.apache.olingo.odata2.api.annotation.edm">EdmComplexType</a></td>
<td class="colLast">
<div class="block">Annotation for a EDM/CSDL ComplexType element.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/olingo/odata2/api/annotation/edm/EdmConcurrencyControl.html" title="annotation in org.apache.olingo.odata2.api.annotation.edm">EdmConcurrencyControl</a></td>
<td class="colLast">
<div class="block">Related to <code>ConcurrencyMode</code> in OData specification.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/olingo/odata2/api/annotation/edm/EdmDocumentation.html" title="annotation in org.apache.olingo.odata2.api.annotation.edm">EdmDocumentation</a></td>
<td class="colLast">
<div class="block">Additional documentation for an EDM element.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/olingo/odata2/api/annotation/edm/EdmEntitySet.html" title="annotation in org.apache.olingo.odata2.api.annotation.edm">EdmEntitySet</a></td>
<td class="colLast">
<div class="block">Annotation for a EDM/CSDL EntitySet element.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/olingo/odata2/api/annotation/edm/EdmEntityType.html" title="annotation in org.apache.olingo.odata2.api.annotation.edm">EdmEntityType</a></td>
<td class="colLast">
<div class="block">Annotation for a EDM/CSDL EntityType element.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/olingo/odata2/api/annotation/edm/EdmFacets.html" title="annotation in org.apache.olingo.odata2.api.annotation.edm">EdmFacets</a></td>
<td class="colLast">
<div class="block">Annotation for definition of EdmFactes on an EdmProperty (for an EdmEntityType or EdmComplexType
which contains the EdmProperty as a field).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/olingo/odata2/api/annotation/edm/EdmFunctionImport.html" title="annotation in org.apache.olingo.odata2.api.annotation.edm">EdmFunctionImport</a></td>
<td class="colLast">
<div class="block">Annotation for definition of an method as an <a href="../../../../../../../org/apache/olingo/odata2/api/annotation/edm/EdmFunctionImport.html" title="annotation in org.apache.olingo.odata2.api.annotation.edm"><code>EdmFunctionImport</code></a> call/endpoint.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/olingo/odata2/api/annotation/edm/EdmFunctionImport.ReturnType.html" title="annotation in org.apache.olingo.odata2.api.annotation.edm">EdmFunctionImport.ReturnType</a></td>
<td class="colLast">
<div class="block">Annotation for definition of the return type of an <a href="../../../../../../../org/apache/olingo/odata2/api/annotation/edm/EdmFunctionImport.html" title="annotation in org.apache.olingo.odata2.api.annotation.edm"><code>EdmFunctionImport</code></a> method.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/olingo/odata2/api/annotation/edm/EdmFunctionImportParameter.html" title="annotation in org.apache.olingo.odata2.api.annotation.edm">EdmFunctionImportParameter</a></td>
<td class="colLast">
<div class="block">Annotation for definition of an EdmFunctionImportParameter for an EdmFunctionImport
which contains the EdmFunctionImportParameter as a parameter.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/olingo/odata2/api/annotation/edm/EdmKey.html" title="annotation in org.apache.olingo.odata2.api.annotation.edm">EdmKey</a></td>
<td class="colLast">
<div class="block">Annotation for definition of an EdmProperty as EdmKey for the EdmEntityType which contains the EdmProperty.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/olingo/odata2/api/annotation/edm/EdmMediaResourceContent.html" title="annotation in org.apache.olingo.odata2.api.annotation.edm">EdmMediaResourceContent</a></td>
<td class="colLast">
<div class="block">Annotation for definition of an <a href="../../../../../../../org/apache/olingo/odata2/api/annotation/edm/EdmProperty.html" title="annotation in org.apache.olingo.odata2.api.annotation.edm"><code>EdmProperty</code></a> as <b>media resource content</b> for the <a href="../../../../../../../org/apache/olingo/odata2/api/annotation/edm/EdmEntityType.html" title="annotation in org.apache.olingo.odata2.api.annotation.edm"><code>EdmEntityType</code></a>
which contains the <a href="../../../../../../../org/apache/olingo/odata2/api/annotation/edm/EdmProperty.html" title="annotation in org.apache.olingo.odata2.api.annotation.edm"><code>EdmProperty</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/olingo/odata2/api/annotation/edm/EdmMediaResourceMimeType.html" title="annotation in org.apache.olingo.odata2.api.annotation.edm">EdmMediaResourceMimeType</a></td>
<td class="colLast">
<div class="block">Annotation for definition of an <a href="../../../../../../../org/apache/olingo/odata2/api/annotation/edm/EdmProperty.html" title="annotation in org.apache.olingo.odata2.api.annotation.edm"><code>EdmProperty</code></a> as <b>mime type for the media resource</b>
of the <a href="../../../../../../../org/apache/olingo/odata2/api/annotation/edm/EdmEntityType.html" title="annotation in org.apache.olingo.odata2.api.annotation.edm"><code>EdmEntityType</code></a> which contains the <a href="../../../../../../../org/apache/olingo/odata2/api/annotation/edm/EdmProperty.html" title="annotation in org.apache.olingo.odata2.api.annotation.edm"><code>EdmProperty</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/olingo/odata2/api/annotation/edm/EdmMediaResourceSource.html" title="annotation in org.apache.olingo.odata2.api.annotation.edm">EdmMediaResourceSource</a></td>
<td class="colLast">
<div class="block">Annotation for definition of an <a href="../../../../../../../org/apache/olingo/odata2/api/annotation/edm/EdmProperty.html" title="annotation in org.apache.olingo.odata2.api.annotation.edm"><code>EdmProperty</code></a> as <b>media resource source</b> for the <a href="../../../../../../../org/apache/olingo/odata2/api/annotation/edm/EdmEntityType.html" title="annotation in org.apache.olingo.odata2.api.annotation.edm"><code>EdmEntityType</code></a>
which contains the <a href="../../../../../../../org/apache/olingo/odata2/api/annotation/edm/EdmProperty.html" title="annotation in org.apache.olingo.odata2.api.annotation.edm"><code>EdmProperty</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/olingo/odata2/api/annotation/edm/EdmNavigationProperty.html" title="annotation in org.apache.olingo.odata2.api.annotation.edm">EdmNavigationProperty</a></td>
<td class="colLast">
<div class="block">Annotation for definition of an EdmNavigationProperty for an EdmEntityType
which contains the navigation property as a field.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/olingo/odata2/api/annotation/edm/EdmProperty.html" title="annotation in org.apache.olingo.odata2.api.annotation.edm">EdmProperty</a></td>
<td class="colLast">
<div class="block">Annotation for definition of an EdmProperty for an EdmEntityType or EdmComplexType
which contains the EdmProperty as a field.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.olingo.odata2.api.annotation.edm Description">Package org.apache.olingo.odata2.api.annotation.edm Description</h2>
<div class="block"><h1>Annotations-API for Entity Data Model definition</h1>
<p>The edm package contains all annotations necessary for definition
of the Entity Data Model (as described in the OData protocol specification
as well as in the Conceptual Schema Definition for the OData Protocol which
both can be found at <a href="http://www.odata.org/">http://www.odata.org/</a>).</p></div>
</div>
<!-- ======= 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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../../org/apache/olingo/odata2/api/batch/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/olingo/odata2/api/annotation/edm/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<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>