com.canto.cumulus.ejp

Interface EJP

All Known Implementing Classes:

AbstractEJP, AbstractGenericEJP

public interface EJP

Embedded Java Plugin interface. This interface is implemented by a plugin (EJP) to be loaded by the Cumulus application. The lifecycle of an EJP is getID() initialize() ... executeScriptingCommend() ... close()

Since:

EJaP 6.0.0

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Shutdown this EJP.
java.lang.String	executeScriptingCommand(java.lang.String cmd) Execute a command that comes in through the scripting API of the Cumulus client.
java.lang.String	getID() Return a language-independent identifier for this plugin.
java.lang.String	getName() Return a user readable name for this plugin.
void	initialize(EJPContext context) Initialize this EJP.

Method Detail

initialize

void initialize(EJPContext context)

Initialize this EJP. The plugin can use this to addc new menu items or menus to the Cumulus client.

Parameters:

context - the EJP context for this EJP instance.

close

void close()

Shutdown this EJP. Ths method can be used to disconnect from any resources that need to be freed.

getID

java.lang.String getID()

Return a language-independent identifier for this plugin. We recommend a scheme like the one for Java packages, e.g. com.mycompany.myproduct.myejp

Returns:

A language-independent identifier for this EJP

getName

java.lang.String getName()

Return a user readable name for this plugin.

Returns:

A user readable name for this plugin

executeScriptingCommand

java.lang.String executeScriptingCommand(java.lang.String cmd)

Execute a command that comes in through the scripting API of the Cumulus client.

Parameters:

cmd - A command string. You can use any format for the information you want to pass. This can be null if the script did not provide a command.

Returns:

A return value (null if executing does not return a value)