org.eclipse.ogee.core/schema/service_implementation.exsd

<?xml version='1.0' encoding='UTF-8'?>
<!-- Schema file written by PDE -->
<schema targetNamespace="org.eclipse.ogee.core" xmlns="http://www.w3.org/2001/XMLSchema">
<annotation>
      <appinfo>
         <meta.schema plugin="org.eclipse.ogee.core" id="service_impl" name="Service Implementation"/>
      </appinfo>
      <documentation>
         This extension-point represents an OData service implementation based on the OData model file.
      </documentation>
   </annotation>

   <element name="extension">
      <annotation>
         <appinfo>
            <meta.element />
         </appinfo>
      </annotation>
      <complexType>
         <sequence>
            <element ref="service_implementation"/>
         </sequence>
         <attribute name="point" type="string" use="required">
            <annotation>
               <documentation>
                  
               </documentation>
            </annotation>
         </attribute>
         <attribute name="id" type="string">
            <annotation>
               <documentation>
                  
               </documentation>
            </annotation>
         </attribute>
         <attribute name="name" type="string">
            <annotation>
               <documentation>
                  
               </documentation>
               <appinfo>
                  <meta.attribute translatable="true"/>
               </appinfo>
            </annotation>
         </attribute>
      </complexType>
   </element>

   <element name="service_implementation">
      <complexType>
         <attribute name="id" type="string" use="required">
            <annotation>
               <documentation>
                  The id of the service implementation extension.
               </documentation>
            </annotation>
         </attribute>
         <attribute name="displayName" type="string" use="required">
            <annotation>
               <documentation>
                  The display name of the service implementation extension. 
This will appear in the wizard&apos;s OData Service Implementation page.
               </documentation>
               <appinfo>
                  <meta.attribute translatable="true"/>
               </appinfo>
            </annotation>
         </attribute>
         <attribute name="description" type="string" use="required">
            <annotation>
               <documentation>
                  The description of the service implementation extension.
This will appear in the wizard&apos;s OData Service Implementation page.
               </documentation>
               <appinfo>
                  <meta.attribute translatable="true"/>
               </appinfo>
            </annotation>
         </attribute>
         <attribute name="icon" type="string">
            <annotation>
               <documentation>
                  The icon of the service implementation extension.
This will appear in the wizard&apos;s OData Service Implementation page.
               </documentation>
               <appinfo>
                  <meta.attribute kind="resource"/>
               </appinfo>
            </annotation>
         </attribute>
         <attribute name="ServiceImplementationProvider" type="string" use="required">
            <annotation>
               <documentation>
                  The ServiceImplementationProvider abstract class.
               </documentation>
               <appinfo>
                  <meta.attribute kind="java" basedOn="org.eclipse.ogee.core.extensions.service.implementation.ServiceImplementationProvider:"/>
               </appinfo>
            </annotation>
         </attribute>
         <attribute name="sortCategory" use="default" value="2">
            <annotation>
               <documentation>
                  OData model extension sort position in the New OData Service page is defined by its sort category. The default category is 2. This mean that the extension will be shown at the end of extensions list.
0 means to place the extension at the beginning of the extensions list.
1 means to place the extension at the middle of the extensions list.
               </documentation>
            </annotation>
            <simpleType>
               <restriction base="string">
                  <enumeration value="0">
                  </enumeration>
                  <enumeration value="1">
                  </enumeration>
                  <enumeration value="2">
                  </enumeration>
               </restriction>
            </simpleType>
         </attribute>
      </complexType>
   </element>

   <annotation>
      <appinfo>
         <meta.section type="since"/>
      </appinfo>
      <documentation>
         0.2.0
      </documentation>
   </annotation>

   <annotation>
      <appinfo>
         <meta.section type="examples"/>
      </appinfo>
      <documentation>
         &lt;p&gt;
 &lt;pre&gt;
    &lt;!-- Example of a Test service implementation extension --&gt;
   &lt;extension
         point=&quot;org.eclipse.ogee.serviceImplementation&quot;&gt;
      &lt;service_implementation              ServiceImplementationProvider=&quot;org.eclipse.ogee.core.extensions.service.implementation.TestServiceImplementationProvider&quot;
            description=&quot;This Test service implementation will create a java project and generate a class.&quot;
            displayName=&quot;Test service implementation&quot;
            id=&quot;org.eclipse.ogee.test.serviceImplementation&quot;&gt;
      &lt;/service_implementation&gt;
   &lt;/extension&gt;
 &lt;/pre&gt;
 &lt;/p&gt;
      </documentation>
   </annotation>

   <annotation>
      <appinfo>
         <meta.section type="apiinfo"/>
      </appinfo>
      <documentation>
         &lt;br&gt;
Plug-ins that want to extend this extension point must implement the &lt;samp&gt;org.eclipse.ogee.core.extensions.service.implementation.ServiceImplementationProvider&lt;/samp&gt; class.
&lt;br&gt;
When extending this class you will get the following methods:
&lt;p&gt;
&lt;pre&gt;
/**
 * Validates wizard parameters provided by a user: project name and OData model file.
 * The framework makes its own validation of project name and only after this method will be called.
 * @return IStatus.OK if parameters are valid, otherwise IStatus.ERROR
 */
 public abstract IStatus validateInputValues();

&lt;/pre&gt;
&lt;/p&gt;
&lt;br&gt;
and you need to implement the following method:
&lt;p&gt;
&lt;pre&gt;
/**
 * This method is responsible for the logic when Finish button is pressed.
 * Here one can use project name and OData model EDMXSet object.
 * @throws ServiceImplementationException if the method fails
 */
 public abstract void doFinish() throws ServiceImplementationException;

&lt;/pre&gt;
&lt;/p&gt;
      </documentation>
   </annotation>

   <annotation>
      <appinfo>
         <meta.section type="implementation"/>
      </appinfo>
      <documentation>
         None.
      </documentation>
   </annotation>


</schema>