IWebServiceXmlDocumentGenerator.java

/*
 * JBoss, Home of Professional Open Source.
 *
 * See the LEGAL.txt file distributed with this work for information regarding copyright ownership and licensing.
 *
 * See the AUTHORS.txt file distributed with this work for a full listing of individual contributors.
 */
package org.teiid.designer.webservice;

import java.util.List;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.emf.ecore.resource.Resource;
import org.teiid.designer.compare.selector.ModelSelector;
import org.teiid.designer.metamodels.webservice.WebServiceComponent;



/** 
 * Interface for a component that generates XML Documents given one or more 
 * {@link org.teiid.designer.metamodels.webservice.WebServiceComponent WebServiceComponent} objects.
 * @since 8.0
 */
public interface IWebServiceXmlDocumentGenerator {

    /**
     * Add a {@link WebServiceComponent} object that should be {@link #generate(IProgressMonitor) processed} 
     * to find {@link org.teiid.designer.metamodels.webservice.Output Output} objects.  For each
     * Output object, a new {@link org.teiid.designer.metamodels.xml.XmlDocument XmlDocument} 
     * will be added to the {@link #getXmlDocumentResource() XML Document model}.
     * @param webServiceComponent the Web Service object being added; may not be null
     * @see #addWebServiceComponents(List)
     * @see #getWebServiceComponents()
     * @since 4.2
     */
    void addWebServiceComponent( WebServiceComponent webServiceComponent );

    /**
     * Add multiple {@link WebServiceComponent} objects that should be 
     * {@link #generate(IProgressMonitor) processed}  to find
     * {@link org.teiid.designer.metamodels.webservice.Output Output} objects.  For each
     * Output object, a new {@link org.teiid.designer.metamodels.xml.XmlDocument XmlDocument} 
     * will be added to the {@link #getXmlDocumentResource() XML Document model}.
     * @param webServiceComponents the list of WebServiceComponent objects being added; may not be null
     * @see #addWebServiceComponent(WebServiceComponent)
     * @see #getWebServiceComponents()
     * @since 4.2
     */
    void addWebServiceComponents( List webServiceComponents );

    /**
     * Return the list of {@link WebServiceComponent} objects that will be 
     * {@link #generate(IProgressMonitor) processed} to locate Output objects.
     * @return the List of WebServiceComponent objects used in generation; never null
     * @see #addWebServiceComponent(WebServiceComponent)
     * @see #addWebServiceComponents(List)
     * @since 4.2
     */
    List getWebServiceComponents();

    /** 
     * Set the model selector containing the {@link #getWebServiceComponents() web service components}.
     * @param wsModelSelector the model selector
     * @since 4.2
     */
    void setWebServiceModelSelector(ModelSelector wsModelSelector);

    /** 
     * Get the model selector containing the {@link #getWebServiceComponents() web service components}.
     * @return the model selector
     * @since 4.2
     */
    ModelSelector getWebServiceModelSelector();

    /**
     * Set the XML Document model into which will be generated new 
     * {@link org.teiid.designer.metamodels.xml.XmlDocument XmlDocument} objects.
     * @param wsModel the EMF resource; may not be null
     * @since 4.2
     */
    void setXmlDocumentResource( Resource wsModel);
    
    /**
     * Get the XML Document model into which will be generated new 
     * {@link org.teiid.designer.metamodels.xml.XmlDocument XmlDocument} objects. 
     * @return the EMF resource
     * @since 4.2
     */
    Resource getXmlDocumentResource();
    
    /**
     * Generate the XML documents into the {@link #getXmlDocumentResource() XML document model}. 
     * @param monitor the progress monitor; may be null
     * @return the status with any information about the generation process, 
     * will be {@link IStatus#isOK() OK} if the generation was successful and
     * had no warnings or errors; never null
     * @see #generate(IProgressMonitor, List)
     * @since 4.2
     */
    IStatus generate( IProgressMonitor monitor );
    
    /**
     * Generate the web service objects and place in the {@link #getWebServiceResource() web service model}. 
     * @param monitor the progress monitor; may be null
     * @param problems the list into which {@link IStatus problems} about the generation process should be placed;
     * may not be null
     * @see #generate(IProgressMonitor)
     * @since 4.2
     */
    void generate( IProgressMonitor monitor, List problems );

}