carbidesdk/com.nokia.carbide.cpp.sdk.doc.user/reference/api/com/nokia/carbide/templatewizard/process/IProcess.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_15) on Tue Jan 06 17:31:54 CST 2009 -->
<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<TITLE>
IProcess (Carbide.c++ SDK API Reference)
</TITLE>
<META NAME="keywords" CONTENT="com.nokia.carbide.templatewizard.process.IProcess interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="IProcess (Carbide.c++ SDK API Reference)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/IProcess.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
<b>Carbide.c++</b></EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../com/nokia/carbide/templatewizard/process/IParameter.html" title="interface in com.nokia.carbide.templatewizard.process"><B>PREV CLASS</B></A>
NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?com/nokia/carbide/templatewizard/process/IProcess.html" target="_top"><B>FRAMES</B></A>
<A HREF="IProcess.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.nokia.carbide.templatewizard.process</FONT>
<BR>
Interface IProcess</H2>
<DL>
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../com/nokia/carbide/templatewizard/process/AbstractProcess.html" title="class in com.nokia.carbide.templatewizard.process">AbstractProcess</A>, <A HREF="../../../../../com/nokia/carbide/templatewizard/process/AbstractProjectProcess.html" title="class in com.nokia.carbide.templatewizard.process">AbstractProjectProcess</A>, <A HREF="../../../../../com/nokia/carbide/templatewizard/processes/CopyFiles.html" title="class in com.nokia.carbide.templatewizard.processes">CopyFiles</A>, <A HREF="../../../../../com/nokia/carbide/cpp/project/core/processes/CopyFilesAndFormatAsCpp.html" title="class in com.nokia.carbide.cpp.project.core.processes">CopyFilesAndFormatAsCpp</A>, <A HREF="../../../../../com/nokia/carbide/cpp/project/core/processes/CopyFilesAndUpdateSymbianOSProjectFiles.html" title="class in com.nokia.carbide.cpp.project.core.processes">CopyFilesAndUpdateSymbianOSProjectFiles</A>, <A HREF="../../../../../com/nokia/carbide/templatewizard/processes/CopyFileTree.html" title="class in com.nokia.carbide.templatewizard.processes">CopyFileTree</A>, <A HREF="../../../../../com/nokia/carbide/templatewizard/processes/CreateFolders.html" title="class in com.nokia.carbide.templatewizard.processes">CreateFolders</A>, <A HREF="../../../../../com/nokia/carbide/cpp/project/core/processes/CreateRezId.html" title="class in com.nokia.carbide.cpp.project.core.processes">CreateRezId</A>, <A HREF="../../../../../com/nokia/carbide/templatewizard/processes/CreateTemplateVariable.html" title="class in com.nokia.carbide.templatewizard.processes">CreateTemplateVariable</A>, <A HREF="../../../../../com/nokia/carbide/cpp/project/core/processes/NewProject.html" title="class in com.nokia.carbide.cpp.project.core.processes">NewProject</A>, <A HREF="../../../../../com/nokia/carbide/templatewizard/processes/OpenFileInEditor.html" title="class in com.nokia.carbide.templatewizard.processes">OpenFileInEditor</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>IProcess</B></DL>
</PRE>
<P>
Represents a process specified as a <process> element in a template xml file,
and executed after successful completion of the wizard specified by the template.<br>
Classes implementing this interface require a 0-argument public constructor,
and will be instantiated separately for each process element existing in a template xml file.<br>
State can be shared between processes through the <CODE>Map</CODE>
returned from <code><A HREF="../../../../../com/nokia/carbide/template/engine/ITemplate.html#getTemplateValues()"><CODE>ITemplate.getTemplateValues()</CODE></A></code><br>
<P>
<P>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/nokia/carbide/templatewizard/process/IProcess.html#mustRunInUIThread()">mustRunInUIThread</A></B>()</CODE>
<BR>
This method is called before executing this process, to determine whether it should be executed in
the UI thread.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/nokia/carbide/templatewizard/process/IProcess.html#process(com.nokia.carbide.template.engine.ITemplate, java.util.List, IProgressMonitor)">process</A></B>(<A HREF="../../../../../com/nokia/carbide/template/engine/ITemplate.html" title="interface in com.nokia.carbide.template.engine">ITemplate</A> template,
java.util.List<<A HREF="../../../../../com/nokia/carbide/templatewizard/process/IParameter.html" title="interface in com.nokia.carbide.templatewizard.process">IParameter</A>> parameters,
IProgressMonitor monitor)</CODE>
<BR>
The main method called to execute this process.</TD>
</TR>
</TABLE>
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="process(com.nokia.carbide.template.engine.ITemplate, java.util.List, IProgressMonitor)"><!-- --></A><H3>
process</H3>
<PRE>
void <B>process</B>(<A HREF="../../../../../com/nokia/carbide/template/engine/ITemplate.html" title="interface in com.nokia.carbide.template.engine">ITemplate</A> template,
java.util.List<<A HREF="../../../../../com/nokia/carbide/templatewizard/process/IParameter.html" title="interface in com.nokia.carbide.templatewizard.process">IParameter</A>> parameters,
IProgressMonitor monitor)
throws CoreException</PRE>
<DL>
<DD>The main method called to execute this process.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>template</CODE> - the <A HREF="../../../../../com/nokia/carbide/template/engine/ITemplate.html" title="interface in com.nokia.carbide.template.engine"><CODE>ITemplate</CODE></A> for this process<DD><CODE>parameters</CODE> - a list of <A HREF="../../../../../com/nokia/carbide/templatewizard/process/IParameter.html" title="interface in com.nokia.carbide.templatewizard.process"><CODE>IParameter</CODE></A><DD><CODE>monitor</CODE> - the <CODE>IProgressMonitor</CODE>
<DT><B>Throws:</B>
<DD><CODE>CoreException</CODE> - if the process fails</DL>
</DD>
</DL>
<HR>
<A NAME="mustRunInUIThread()"><!-- --></A><H3>
mustRunInUIThread</H3>
<PRE>
boolean <B>mustRunInUIThread</B>()</PRE>
<DL>
<DD>This method is called before executing this process, to determine whether it should be executed in
the UI thread.
<P>
<DD><DL>
<DT><B>Returns:</B><DD><code>true</code> to ensure this process is executed in the UI thread.<DT><B>See Also:</B><DD><CODE>org.eclipse.swt.widgets.Display#syncExec(Runnable)</CODE></DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/IProcess.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
<b>Carbide.c++</b></EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../com/nokia/carbide/templatewizard/process/IParameter.html" title="interface in com.nokia.carbide.templatewizard.process"><B>PREV CLASS</B></A>
NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?com/nokia/carbide/templatewizard/process/IProcess.html" target="_top"><B>FRAMES</B></A>
<A HREF="IProcess.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<div id="footer">Copyright © 2010 Nokia Corporation and/or its subsidiary(-ies). All rights reserved. <br>License: <a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a></div>
</BODY>
</HTML>