com.smartbear.ready.core.module

Interface ReadyApiModule

All Superinterfaces:

ScannableReadyApiModule

All Known Implementing Classes:

PrivateReadyApiModule

public interface ReadyApiModule
extends ScannableReadyApiModule

Method Summary

Modifier and Type	Method and Description
void	activate() Called when the module is selected in the module-bar
void	deactivate() Called when another module is selected in the module-bar
void	displayActivationGui()
String	getDescription() Returns the description of the module for display purposes.
ModuleGui	getGui() Gets the GUI object for this Module
String	getId() Returns a unique ID for this module - for referring between modules
int	getMenuPosition() Returns the menu position of this module, see ReadyApiModulePositions class
ModuleType	getModuleType()
void	initialize() Method to initialize the module.
boolean	isEnabled()

Methods inherited from interface com.smartbear.ready.core.ScannableReadyApiModule

getName

Method Detail

getId

String getId()

Returns a unique ID for this module - for referring between modules

Returns:

the unique ID of this module

getDescription

String getDescription()

Returns the description of the module for display purposes.

Returns:

the description of the module

getMenuPosition

int getMenuPosition()

Returns the menu position of this module, see ReadyApiModulePositions class

initialize

void initialize()
         throws ModuleInitializationException

Method to initialize the module. Called once.

Throws:

ModuleInitializationException

getGui

ModuleGui getGui()

Gets the GUI object for this Module

activate

void activate()

Called when the module is selected in the module-bar

deactivate

void deactivate()

Called when another module is selected in the module-bar

getModuleType

ModuleType getModuleType()

isEnabled

boolean isEnabled()

displayActivationGui

void displayActivationGui()