/*
 * 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.ui.viewsupport;

import java.util.Properties;

/**
 * This interface provides a means for wizards, actions and dialogs to set simple property values in order to hold state within
 * the application.
 * 
 * The initial need for this context was to enable cheat sheets to obtain some kind of state so subsequent tasks could populate
 * downstream wizards and dialogs with previously defined values.
 * 
 * Example would be a cheat sheet step of "Create Teiid Model Project" followed by a "Import from JDBC". The assumption here would be
 * that a user expected the new project be pre-selected in import wizard.
 * 
 *
 * @since 8.0
 */
public interface IPropertiesContext {
	public static final String KEY_PROJECT_NAME = "projectName"; //$NON-NLS-1$
    public static final String KEY_SOURCES_FOLDER = "sourcesFolder"; //$NON-NLS-1$
    public static final String KEY_VIEWS_FOLDER = "viewsFolder"; //$NON-NLS-1$
    public static final String KEY_SCHEMA_FOLDER = "schemaFolder"; //$NON-NLS-1$
    public static final String KEY_WS_FOLDER = "wsFolder"; //$NON-NLS-1$
	public static final String KEY_LAST_SOURCE_MODEL_NAME = "lastSourceModelName"; //$NON-NLS-1$
	public static final String KEY_LAST_VIEW_MODEL_NAME = "lastViewModelName"; //$NON-NLS-1$
	public static final String KEY_LAST_CONNECTION_PROFILE_ID = "lastConnectionProfileId"; //$NON-NLS-1$
	public static final String KEY_LAST_VDB_NAME = "lastVdbName"; //$NON-NLS-1$
	public static final String KEY_PREVIEW_TARGET_OBJECT = "previewTargetObject"; //$NON-NLS-1$
	public static final String KEY_PREVIEW_TARGET_MODEL = "previewTargetModel"; //$NON-NLS-1$
	public static final String KEY_LAST_SOURCE_MODEL_OBJECT_NAME = "lastSourceModelObjectName"; //$NON-NLS-1$
	public static final String KEY_LAST_VIEW_MODEL_OBJECT_NAME = "lastViewModelObjectName"; //$NON-NLS-1$
	public static final String KEY_VDB_DATA_SOURCE_JNDI_NAME = "vdbJndiName"; //$NON-NLS-1$
	public static final String KEY_PROJECT_STATUS = "projectStatus"; //$NON-NLS-1$
	
	public static final String KEY_IMPORT_XML_TYPE = "xmlImportType"; //$NON-NLS-1$
	public static final String IMPORT_XML_LOCAL = "local"; //$NON-NLS-1$
	public static final String IMPORT_XML_REMOTE = "remote"; //$NON-NLS-1$
	public static final String NO_OPEN_PROJECT = "noOpenProject"; //$NON-NLS-1$
	public static final String OPEN_PROJECTS_EXIST = "openProjectsExist"; //$NON-NLS-1$
	
	public static final String KEY_GUIDE_ID = "guideID"; //$NON-NLS-1$

	/**
	 * Sets the properties context object
	 * 
	 * @param properties
	 */
	public void setProperties(Properties properties);
}