org.carewebframework.shell.plugins

Class PluginResourceAction

java.lang.Object

org.carewebframework.shell.plugins.PluginResourceAction

All Implemented Interfaces:

IPluginResource

public class PluginResourceAction
extends Object
implements IPluginResource

Resource for declaring actions supported by a plugin.

Constructor Summary

Constructors

Constructor and Description
PluginResourceAction()

Method Summary

Modifier and Type	Method and Description
String	getId() Returns the unique id associated with the action.
String	getLabel() Returns the label of the action.
String	getScript() Returns the script of the action.
void	register(CareWebShell shell, ElementBase owner, boolean register) Registers/unregisters an action resource.
void	setId(String id) Sets the unique id associated with the action.
void	setLabel(String label) Sets the label of the action.
void	setScript(String script) Sets the script of the action.

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginResourceAction

public PluginResourceAction()

Method Detail

getId

public String getId()

Returns the unique id associated with the action.

Returns:

The action's unique id.

setId

public void setId(String id)

Sets the unique id associated with the action.

Parameters:

id - The action's unique id.

getLabel

public String getLabel()

Returns the label of the action.

Returns:

The action's label.

setLabel

public void setLabel(String label)

Sets the label of the action.

Parameters:

label - The new label.

getScript

public String getScript()

Returns the script of the action.

Returns:

The action's script.

setScript

public void setScript(String script)

Sets the script of the action.

Parameters:

script - The new script.

register

public void register(CareWebShell shell,
                     ElementBase owner,
                     boolean register)

Registers/unregisters an action resource.

Specified by:

register in interface IPluginResource

Parameters:

shell - The running shell.

owner - Owner of the resource.

register - If true, register the resource. If false, unregister it.