plugins/org.eclipse.wst.common.modulecore/modulecore-src/org/eclipse/wst/common/componentcore/datamodel/properties/IWorkbenchComponentBuilderDataModelProperties.java

/*******************************************************************************
 * Copyright (c) 2003, 2004, 2005 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors:
 * IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.wst.common.componentcore.datamodel.properties;

import org.eclipse.wst.common.frameworks.datamodel.IDataModelProperties;

/**
 * <p>
 * IWorkbenchComponentBuilderDataModelProperties supplies the properties to the IDataModel and 
 * associated DataModelProvider WorkbenchComponentBuilderDataModelProvider used by the 
 * ComponentStructuralBuilder.
 * @see org.eclipse.wst.common.componentcore.internal.builder.ComponentStructuralBuilder
 * </p>
 * <p>
 * This interface is not intended to be implemented by clients.
 * </p>
 * 
 * @see org.eclipse.wst.common.frameworks.datamodel.IDataModelProvider
 * @see org.eclipse.wst.common.frameworks.datamodel.DataModelFactory
 * @see org.eclipse.wst.common.frameworks.datamodel.IDataModelProperties
 * 
 * @since 1.0
 */
public interface IWorkbenchComponentBuilderDataModelProperties extends IDataModelProperties{
    /**
     * Required, type String. The initializing builder will set this field to the name value of the 
     * project which is currently being built.
     */
	public static final String PROJECT = "IWorkbenchComponentBuilderDataModelProperties.PROJECT"; //$NON-NLS-1$
    /**
     * Required, type project relative IFolder.  This represents the Folder output container defined for the given 
     * WORKBENCH_COMPONENT.
     */
	public static final String OUTPUT_CONTAINER = "IWorkbenchComponentBuilderDataModelProperties.OUTPUT_CONTAINER"; //$NON-NLS-1$
    /**
     * Required, type WorkbenchComponent. The initializing builder will set this field to the WorkbenchComponent value of the 
     * Component to be built.
     */
	public static final String WORKBENCH_COMPONENT = "IWorkbenchComponentBuilderDataModelProperties.WORKBENCH_MODULE_RESOURCES"; //$NON-NLS-1$
	/**
	 * Required, type List of DependentDeployableModuleDataModel  The initializing builder will set this field to a List of initialized DataModels for 
     * the ReferencedComponentBuilderDataModelProvider.  
     * This field represents builders (IDataModel( for all Referenced Components present in the current WorkbenchComponent.
     * 
     * @see org.eclipse.wst.common.frameworks.datamodel.IDataModel
     * @see ReferencedComponentBuilderDataModelProvider
     */
	public static final String DEPENDENT_COMPONENT_DM_LIST = "IWorkbenchComponentBuilderDataModelProperties.DEPENDENT_COMPONENT_DM_LIST"; //$NON-NLS-1$
    /**
     * Required, type ComponentCore. The initializing builder will set this field to the ModuleCore associated
     * with the project which is currently being built.  This field can be used to retrieve information about components and their associated 
     * dependent components present in the current project.
     * 
     * @see org.eclipse.wst.common.componentcore.ComponentCore
     */
	public static final String COMPONENT_CORE = "IWorkbenchComponentBuilderDataModelProperties.COMPONENT_CORE";
    /**
     * Required, type Integer. The initializing builder will set this field to the int value based on the build
     * kind passed to the IncrementalProjectBuilder
     * 
     * @see IncrementalProjectBuilder.FULL_BUILD
     * <li><code>FULL_BUILD</code>- indicates a full build.</li>
     * 
     * @see IncrementalProjectBuilder.INCREMENTAL_BUILD
     * <li><code>INCREMENTAL_BUILD</code>- indicates an incremental build.</li>
     * 
     * @see IncrementalProjectBuilder.AUTO_BUILD
     * <li><code>AUTO_BUILD</code>- indicates an automatically triggered
     */
    public static final String BUILD_KIND_FOR_DEP = "IWorkbenchComponentBuilderDataModelProperties.BUILD_KIND_FOR_DEP"; //$NON-NLS-1$
    
}