org.symbian.tools.wrttools/src/org/symbian/tools/wrttools/core/deployer/IWidgetDeployer.java
changeset 458 5ff93668b08c
parent 457 f1087591ff71
child 459 c278f0c8917f
equal deleted inserted replaced
457:f1087591ff71 458:5ff93668b08c
     1 /**
       
     2  * Copyright (c) 2009 Symbian Foundation and/or its subsidiary(-ies).
       
     3  * All rights reserved.
       
     4  * This component and the accompanying materials are made available
       
     5  * under the terms of the License "Eclipse Public License v1.0"
       
     6  * which accompanies this distribution, and is available
       
     7  * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8  *
       
     9  * Initial Contributors:
       
    10  * Symbian Foundation - initial contribution.
       
    11  * Contributors:
       
    12  * Description:
       
    13  * Overview:
       
    14  * Details:
       
    15  * Platforms/Drives/Compatibility:
       
    16  * Assumptions/Requirement/Pre-requisites:
       
    17  * Failures and causes:
       
    18  */
       
    19 
       
    20 package org.symbian.tools.wrttools.core.deployer;
       
    21 
       
    22 import org.eclipse.core.runtime.IProgressMonitor;
       
    23 import org.eclipse.core.runtime.IStatus;
       
    24 import org.symbian.tools.wrttools.core.status.IWRTStatusListener;
       
    25 
       
    26 /**
       
    27  * The main interface for the Widget Project Deployment.The deployer will deploy the
       
    28  * widget to the different devices which can be an emulator, server etc. 
       
    29  * @author avraina
       
    30  *
       
    31  */
       
    32 public interface IWidgetDeployer {
       
    33 
       
    34 	/**
       
    35 	 * The method will deploy the widget to the target.
       
    36 	 * All the deployer tools must implement this method. Each deployer which 
       
    37 	 * @param inputPath the widget path from where the widget needs to be deployed.
       
    38 	 * @param destinationPath the destination path to which widget will be deployed. 
       
    39 	 * This can be an emulator , server or any other device
       
    40 	 * @return integer IStatus code. IStatus.OK for success, IStatus.CANCEL if the user canceled, IStatus.ERROR if an 
       
    41 	 * error was caught and reported to the status listener.
       
    42 	 * @throws DeployException throws a Deploy Exception if anything goes wrong while
       
    43 	 * deployment is going on.
       
    44 	 */
       
    45 	public IStatus deploy(String inputPath, String destinationPath, 
       
    46 						IProgressMonitor progressMonitor) throws DeployException;
       
    47 
       
    48 	/**
       
    49 	 * Sets the status listner associated with the widget deployer
       
    50 	 * @param statusListener the status listner to be associated.
       
    51 	 */
       
    52 	public void setStatusListener(IWRTStatusListener statusListener);
       
    53 
       
    54     public boolean needsReport();
       
    55 
       
    56 }