IWebRunnable Interface

com.bea.ide.workspace
IWebRunnable Interface

public interface IWebRunnable

This interface defines a driver that will be used to determine if a file can be either run or built in a Web Application project.


All Known Implementing Classes
DefaultDebugRunnable

Method Summary

public boolean
canRun()
Gets called right before the IDE start to run a file.
public URI
getPreferredUri()
This returns the URI for the document that should get run instead of this one.
public URL
getRunnableUrl()
This returns the URL to hit in the case of running
public boolean
isBuildable()
Tells if the file type can be built.
public boolean
isRunnable()
Tells if the file type can be run via Debug/Start.
public boolean
showPreferredDialog(URI preferredUri)
This shows a dialog to the user informing them that the document they clicked on is not the one that will be run.

Method Detail

canRun() Method

public boolean canRun()
Gets called right before the IDE start to run a file. This allows the document to determine if there is anything that needs to be done before the document is run.

Returns

true -- Everything is O.K. the RunDriver can run the file false-- Cancel the run.

getPreferredUri() Method

public URI getPreferredUri()
This returns the URI for the document that should get run instead of this one. This can return null, if the current document is the correct one to run. This will be used by Start and StartWithDebugging, however, there can be other actions that do not obey this.

Returns

null if the current document is the prefered document, otherwise an IDocument for the file to run.

getRunnableUrl() Method

public URL getRunnableUrl()
This returns the URL to hit in the case of running


isBuildable() Method

public boolean isBuildable()
Tells if the file type can be built.


isRunnable() Method

public boolean isRunnable()
Tells if the file type can be run via Debug/Start.


showPreferredDialog(URI) Method

public boolean showPreferredDialog(URI preferredUri)
This shows a dialog to the user informing them that the document they clicked on is not the one that will be run.

Returns

false -- the user dissented, so the request should be canceled true -- the user accepted, so the preferred URI should be used.