blob: cf9f94e73df5bebb1b19ee2b1bfab256a86adb38 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<title>EGF Contract</title>
<style type="text/css">@import url("../../book.css");</style>
<style type="text/css">@import url("../../schema.css");</style>
</HEAD>
<BODY>
<H1 style="text-align:center">EGF Contract</H1>
<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Identifier: </h6>org.eclipse.egf.core.contract<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Since: </h6>[Enter the first release in which this extension point appears.]
<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Description: </h6>Extension point to define a contract.<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Configuration Markup:</h6>
<p></p>
<p class="code SchemaDtd">&lt;!ELEMENT <a name="e.extension">extension</a> (<a href="#e.contract">contract</a>)&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST extension</p>
<p class="code SchemaDtdAttlist">point&nbsp;CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">id&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED</p><p class="code SchemaDtdAttlist">name&nbsp;&nbsp;CDATA #IMPLIED</p>&gt;</p>
<p></p>
<ul class="ConfigMarkupAttlistDesc">
</ul>
<br><p class="code SchemaDtd">&lt;!ELEMENT <a name="e.contract">contract</a> (<a href="#e.contractElement">contractElement</a>)*&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST contract</p>
<p class="code SchemaDtdAttlist">id&nbsp;CDATA #REQUIRED</p>&gt;</p>
<p></p>
<p class="ConfigMarkupElementDesc">
Defines a contract element list.</p>
<br>
<ul class="ConfigMarkupAttlistDesc">
<li><b>id</b> - </li>
</ul>
<br><p class="code SchemaDtd">&lt;!ELEMENT <a name="e.contractElement">contractElement</a> (<a href="#e.description">description</a>? , (<a href="#e.contractElementRef">contractElementRef</a>)*)*&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST contractElement</p>
<p class="code SchemaDtdAttlist">id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">name&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">type&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">mandatory&nbsp;(true | false) </p>&gt;</p>
<p></p>
<p class="ConfigMarkupElementDesc">
Defines a couple (name, type). Type has to be a java class. A contract element can reference another one through contractReferenceId attribute.</p>
<br>
<ul class="ConfigMarkupAttlistDesc">
<li><b>id</b> - </li>
<li><b>name</b> - Contract unique key.</li>
<li><b>type</b> - </li>
<li><b>mandatory</b> - Whether or not a context element must match this contract element.
If the contract element is mandatory, it should be valued by a context element.
If not set, the contract element is mandatory.</li>
</ul>
<br><p class="code SchemaDtd">&lt;!ELEMENT <a name="e.contractElementRef">contractElementRef</a> EMPTY&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST contractElementRef</p>
<p class="code SchemaDtdAttlist">contractElementReferenceId&nbsp;CDATA #REQUIRED</p>&gt;</p>
<p></p>
<ul class="ConfigMarkupAttlistDesc">
<li><b>contractElementReferenceId</b> - </li>
</ul>
<br><p class="code SchemaDtd">&lt;!ELEMENT <a name="e.description">description</a> EMPTY&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST description</p>
<p class="code SchemaDtdAttlist">id&nbsp;CDATA #REQUIRED</p>&gt;</p>
<p></p>
<p class="ConfigMarkupElementDesc">
Define a description node.</p>
<br>
<ul class="ConfigMarkupAttlistDesc">
<li><b>id</b> - </li>
</ul>
<br><h6 class="CaptionFigColumn SchemaHeader">Examples: </h6>[Enter extension point usage example here.]
<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Supplied Implementation: </h6>[Enter information about supplied implementation of this extension point.]
<p></p>
<br>
<p class="note SchemaCopyright">
</p>
</BODY>
</HTML>