oracle.jdeveloper.deploy.dt.wizard

Class DeployWizard

java.lang.Object

oracle.ide.wizard.Wizard

oracle.jdeveloper.deploy.dt.wizard.DeployWizard

All Implemented Interfaces:

Invokable

public class DeployWizard
extends Wizard

This class is used to create and display a Wizard that can guide a user through the deployment process.

The Wizard is constructed on-the-fly using the Deployment ToolkitRegistry depending on the selected element in the Context passed to isAvailable() or invoke()

If the Wizard steps have been successfully completed, the getDeployCommand() method will return the command to be used to run the deployment. The command should be run on a non-event thread.

 DeployWizard wizard = new DeployWizard();
 Context context = Context.newIdeContext();
 context.setElement( myProfile );
 if ( wizard.isAvailable( context )) {
   boolean success = wizard.invoke(context);
   if ( success ) {
     final DeployCommand cmd = wizard.getDeployCommand();
     Runnable cmdRunnable = new Runnable() {
         void run() {
           cmd.doIt();
         }
     }
     Thread thread = new Thread(cmdRunnable);
     thread.start();
   }
 }
 

Constructor Summary

Constructors

Constructor and Description
DeployWizard()

Method Summary

Methods

Modifier and Type	Method and Description
DeployCommand	getCommand()
Namespace	getData() Returns the data object used by this Wizard.
java.lang.String	getShortLabel() Provides the label that represents the Wizard in the Object Gallery.
boolean	invoke(Context context) Invokes the Wizard for given context.
boolean	isAvailable(Context context) Checks if a DeployWizard can be created for given Context.

Methods inherited from class oracle.ide.wizard.Wizard

getIcon, getLegacyParams, getLongLabel, getMenuSpecification, getToolTipText, getWizardId, setLegacyParams, setWizardId, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DeployWizard

public DeployWizard()

Method Detail

isAvailable

public boolean isAvailable(Context context)

Checks if a DeployWizard can be created for given Context.

This command can return false if there is no DeployWizardBuilder in the ToolkitRegistry that recognizes the context. Typically, most builders would recognize the selected Element in the context (as returned by context.getElement() although this is not mandated. A builder can choose to create a wizard for more than one element in the context.

Specified by:

isAvailable in class Wizard

Parameters:

context -

Returns:

true if a wizard can be built for the context.

invoke

public boolean invoke(Context context)

Invokes the Wizard for given context.

Parameters:

context -

Returns:

false if a Wizard could not be built for given context, or if the wizard did not finish successfully.

See Also:

isAvailable(context)

getCommand

public DeployCommand getCommand()

getData

public Namespace getData()

Returns the data object used by this Wizard. The data object is null of the Wizard has not been invoked yet.

Returns:

a namespace object containing the data used by the wizard's panels.

getShortLabel

public java.lang.String getShortLabel()

Description copied from class: Wizard

Provides the label that represents the Wizard in the Object Gallery. The label should be a noun or noun phrase naming the item that is created by this Wizard and should omit the word "new". Examples: "Java Class", "Java Interface", "XML Document", "Database Connection".

Specified by:

getShortLabel in class Wizard

Returns:

The human readable label of the Wizard.