com.sodius.mdw.core
Interface WorkbenchConfiguration


public interface WorkbenchConfiguration

Defines properties to configure the workbench.

This interface is not intended to be implemented by clients.

See Also:
MDWorkbench.getConfiguration()

Method Summary
 CommandLine getCommandLine()
          Returns the command line that launched the workbench.
 Logger getLogger()
          Returns the logger, used to display errors and warnings, as well as debugging information.
 MDWorkbench getWorkbench()
          Return the configured workbench.
 boolean isHeadless()
          Determines wheter the workbench runs in headless mode (no user interface).
 void setCommandLine(CommandLine commandLine)
          Sets the command line that launched the workbench.
 void setHeadless(boolean headless)
          Specifies wheter the workbench runs in headless mode (no user interface).
 void setLogger(Logger logger)
          Sets the logger to use to display errors and warnings, as well as debugging information.
 

Method Detail

getWorkbench

MDWorkbench getWorkbench()
Return the configured workbench.

Returns:
the workbench.

isHeadless

boolean isHeadless()
Determines wheter the workbench runs in headless mode (no user interface).

This property can be used for example by template and script designers to check wheter they should request options to the end-user through an dialog box or a configuration file.

Returns:
true if the workbench runs in headless mode (no user interface), false otherwise.

setHeadless

void setHeadless(boolean headless)
Specifies wheter the workbench runs in headless mode (no user interface).

Parameters:
headless - true if the workbench should runs in headless mode (no user interface), false otherwise.

getLogger

Logger getLogger()
Returns the logger, used to display errors and warnings, as well as debugging information.

Returns:
the logger.

setLogger

void setLogger(Logger logger)
Sets the logger to use to display errors and warnings, as well as debugging information.

Parameters:
logger - the logger.

getCommandLine

CommandLine getCommandLine()
Returns the command line that launched the workbench.

Returns:
the main command line.

setCommandLine

void setCommandLine(CommandLine commandLine)
Sets the command line that launched the workbench.

Parameters:
commandLine - the command line.