blob: 4733a30ea6eea204669d2c0c3971ae1e86e88fa8 [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:37 CEST 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.apache.olingo.commons.api.edm (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="org.apache.olingo.commons.api.edm (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 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/commons/api/data/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/olingo/commons/api/edm/annotation/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/olingo/commons/api/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.commons.api.edm</h1>
<div class="docSummary">
<div class="block">Contains representations for EDM objects created during the URI parsing</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="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/commons/api/edm/Edm.html" title="interface in org.apache.olingo.commons.api.edm">Edm</a></td>
<td class="colLast">
<div class="block">Entity Data Model (EDM)
<br/>
Interface representing a Entity Data Model as described in the Conceptual Schema Definition.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmAction.html" title="interface in org.apache.olingo.commons.api.edm">EdmAction</a></td>
<td class="colLast">
<div class="block">A CSDL action.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmActionImport.html" title="interface in org.apache.olingo.commons.api.edm">EdmActionImport</a></td>
<td class="colLast">
<div class="block">An EdmActionImport element.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmActionImportInfo.html" title="interface in org.apache.olingo.commons.api.edm">EdmActionImportInfo</a></td>
<td class="colLast">
<div class="block">Objects of this class contain information about one action import inside the EntityDataModel.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmAnnotatable.html" title="interface in org.apache.olingo.commons.api.edm">EdmAnnotatable</a></td>
<td class="colLast">
<div class="block">Can be applied to CSDL elements as described in the Conceptual Schema Definition Language.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmAnnotation.html" title="interface in org.apache.olingo.commons.api.edm">EdmAnnotation</a></td>
<td class="colLast">
<div class="block">This class models an OData Annotation which can be applied to a target.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmAnnotations.html" title="interface in org.apache.olingo.commons.api.edm">EdmAnnotations</a></td>
<td class="colLast">
<div class="block">This is used to apply a group of annotations to a single model element.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmBindingTarget.html" title="interface in org.apache.olingo.commons.api.edm">EdmBindingTarget</a></td>
<td class="colLast">
<div class="block">Entity Sets or Singletons can be bound to each other using a navigation property binding so an
<a href="../../../../../../org/apache/olingo/commons/api/edm/EdmBindingTarget.html" title="interface in org.apache.olingo.commons.api.edm"><code>EdmBindingTarget</code></a> can either be an <a href="../../../../../../org/apache/olingo/commons/api/edm/EdmEntitySet.html" title="interface in org.apache.olingo.commons.api.edm"><code>EdmEntitySet</code></a> or an <a href="../../../../../../org/apache/olingo/commons/api/edm/EdmSingleton.html" title="interface in org.apache.olingo.commons.api.edm"><code>EdmSingleton</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmComplexType.html" title="interface in org.apache.olingo.commons.api.edm">EdmComplexType</a></td>
<td class="colLast">
<div class="block">A CSDL ComplexType element.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmElement.html" title="interface in org.apache.olingo.commons.api.edm">EdmElement</a></td>
<td class="colLast">
<div class="block">An <a href="../../../../../../org/apache/olingo/commons/api/edm/EdmElement.html" title="interface in org.apache.olingo.commons.api.edm"><code>EdmElement</code></a> can either be an <a href="../../../../../../org/apache/olingo/commons/api/edm/EdmNavigationProperty.html" title="interface in org.apache.olingo.commons.api.edm"><code>EdmNavigationProperty</code></a>, an <a href="../../../../../../org/apache/olingo/commons/api/edm/EdmProperty.html" title="interface in org.apache.olingo.commons.api.edm"><code>EdmProperty</code></a> or an
<a href="../../../../../../org/apache/olingo/commons/api/edm/EdmParameter.html" title="interface in org.apache.olingo.commons.api.edm"><code>EdmParameter</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmEntityContainer.html" title="interface in org.apache.olingo.commons.api.edm">EdmEntityContainer</a></td>
<td class="colLast">
<div class="block">A CSDL EntityContainer element.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmEntitySet.html" title="interface in org.apache.olingo.commons.api.edm">EdmEntitySet</a></td>
<td class="colLast">
<div class="block">A CSDL EntitySet element.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmEntityType.html" title="interface in org.apache.olingo.commons.api.edm">EdmEntityType</a></td>
<td class="colLast">
<div class="block">A CSDL EntityType element.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmEnumType.html" title="interface in org.apache.olingo.commons.api.edm">EdmEnumType</a></td>
<td class="colLast">
<div class="block">An EdmEnumType represents a set of related values.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmFunction.html" title="interface in org.apache.olingo.commons.api.edm">EdmFunction</a></td>
<td class="colLast">
<div class="block">An EdmFunction as described in the OData specification</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmFunctionImport.html" title="interface in org.apache.olingo.commons.api.edm">EdmFunctionImport</a></td>
<td class="colLast">
<div class="block">A CSDL FunctionImport element</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmKeyPropertyRef.html" title="interface in org.apache.olingo.commons.api.edm">EdmKeyPropertyRef</a></td>
<td class="colLast">
<div class="block">A key property reference element.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmMappable.html" title="interface in org.apache.olingo.commons.api.edm">EdmMappable</a></td>
<td class="colLast">
<div class="block">EdmMappable can be applied to CSDL elements to associate additional information.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmMapping.html" title="interface in org.apache.olingo.commons.api.edm">EdmMapping</a></td>
<td class="colLast">
<div class="block">EdmMapping holds custom mapping information which can be applied to a CSDL element.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmMember.html" title="interface in org.apache.olingo.commons.api.edm">EdmMember</a></td>
<td class="colLast">
<div class="block">An <a href="../../../../../../org/apache/olingo/commons/api/edm/EdmEnumType.html" title="interface in org.apache.olingo.commons.api.edm"><code>EdmEnumType</code></a> member element.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmNamed.html" title="interface in org.apache.olingo.commons.api.edm">EdmNamed</a></td>
<td class="colLast">
<div class="block">EdmNamed is the base interface for nearly all CSDL constructs.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmNavigationProperty.html" title="interface in org.apache.olingo.commons.api.edm">EdmNavigationProperty</a></td>
<td class="colLast">
<div class="block">A CSDL NavigationProperty element
<br/>
EdmNavigationProperty allows navigation from one entity type to another via a relationship.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmNavigationPropertyBinding.html" title="interface in org.apache.olingo.commons.api.edm">EdmNavigationPropertyBinding</a></td>
<td class="colLast">
<div class="block">A navigation property binding which binds entity sets or singletons with each other.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmOperation.html" title="interface in org.apache.olingo.commons.api.edm">EdmOperation</a></td>
<td class="colLast">
<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>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmOperationImport.html" title="interface in org.apache.olingo.commons.api.edm">EdmOperationImport</a></td>
<td class="colLast">
<div class="block">An EdmOperationImport can be an EdmActionImport or an EdmFunctionImport.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmOperationImportInfo.html" title="interface in org.apache.olingo.commons.api.edm">EdmOperationImportInfo</a></td>
<td class="colLast">
<div class="block">Objects of this class contain information about one action or function import inside the EntityDataModel.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmParameter.html" title="interface in org.apache.olingo.commons.api.edm">EdmParameter</a></td>
<td class="colLast">
<div class="block">A CSDL parameter element</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmPrimitiveType.html" title="interface in org.apache.olingo.commons.api.edm">EdmPrimitiveType</a></td>
<td class="colLast">
<div class="block">EdmPrimitiveType is a primitive type as defined in the Entity Data Model (EDM).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmProperty.html" title="interface in org.apache.olingo.commons.api.edm">EdmProperty</a></td>
<td class="colLast">
<div class="block">A CSDL Property element.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmReferentialConstraint.html" title="interface in org.apache.olingo.commons.api.edm">EdmReferentialConstraint</a></td>
<td class="colLast">
<div class="block">A referential constraint of a navigation property.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmReturnType.html" title="interface in org.apache.olingo.commons.api.edm">EdmReturnType</a></td>
<td class="colLast">
<div class="block">An <a href="../../../../../../org/apache/olingo/commons/api/edm/EdmReturnType.html" title="interface in org.apache.olingo.commons.api.edm"><code>EdmReturnType</code></a> of an <a href="../../../../../../org/apache/olingo/commons/api/edm/EdmOperation.html" title="interface in org.apache.olingo.commons.api.edm"><code>EdmOperation</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmSchema.html" title="interface in org.apache.olingo.commons.api.edm">EdmSchema</a></td>
<td class="colLast">
<div class="block">A csdl schema element</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmSingleton.html" title="interface in org.apache.olingo.commons.api.edm">EdmSingleton</a></td>
<td class="colLast">
<div class="block">An <a href="../../../../../../org/apache/olingo/commons/api/edm/EdmSingleton.html" title="interface in org.apache.olingo.commons.api.edm"><code>EdmSingleton</code></a> represents a single entity inside the entity model.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmStructuredType.html" title="interface in org.apache.olingo.commons.api.edm">EdmStructuredType</a></td>
<td class="colLast">
<div class="block">EdmStructuralType is the base for a complex type or an entity type.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmTerm.html" title="interface in org.apache.olingo.commons.api.edm">EdmTerm</a></td>
<td class="colLast">
<div class="block">An <a href="../../../../../../org/apache/olingo/commons/api/edm/EdmTerm.html" title="interface in org.apache.olingo.commons.api.edm"><code>EdmTerm</code></a> defines a term in a vocabulary.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmType.html" title="interface in org.apache.olingo.commons.api.edm">EdmType</a></td>
<td class="colLast">
<div class="block">EdmType holds the namespace of a given type and its type as <a href="../../../../../../org/apache/olingo/commons/api/edm/constants/EdmTypeKind.html" title="enum in org.apache.olingo.commons.api.edm.constants"><code>EdmTypeKind</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmTyped.html" title="interface in org.apache.olingo.commons.api.edm">EdmTyped</a></td>
<td class="colLast">
<div class="block">EdmTyped indicates if an EDM element is of a special type and holds the multiplicity of that type.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmTypeDefinition.html" title="interface in org.apache.olingo.commons.api.edm">EdmTypeDefinition</a></td>
<td class="colLast">
<div class="block">An <a href="../../../../../../org/apache/olingo/commons/api/edm/EdmTypeDefinition.html" title="interface in org.apache.olingo.commons.api.edm"><code>EdmTypeDefinition</code></a> defines a specialization of one of the possible primitive types.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/commons/api/edm/FullQualifiedName.html" title="class in org.apache.olingo.commons.api.edm">FullQualifiedName</a></td>
<td class="colLast">
<div class="block">A full qualified name of any element in the EDM consists of a name and a namespace.</div>
</td>
</tr>
</tbody>
</table>
</li>
<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/commons/api/edm/EdmPrimitiveTypeKind.html" title="enum in org.apache.olingo.commons.api.edm">EdmPrimitiveTypeKind</a></td>
<td class="colLast">
<div class="block">Enumeration of all primitive type kinds.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/commons/api/edm/TargetType.html" title="enum in org.apache.olingo.commons.api.edm">TargetType</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmException.html" title="class in org.apache.olingo.commons.api.edm">EdmException</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmPrimitiveTypeException.html" title="class in org.apache.olingo.commons.api.edm">EdmPrimitiveTypeException</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.olingo.commons.api.edm Description">Package org.apache.olingo.commons.api.edm Description</h2>
<div class="block">Contains representations for EDM objects created during the URI parsing</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/commons/api/data/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/olingo/commons/api/edm/annotation/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/olingo/commons/api/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&#x2013;2018 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>