org.carewebframework.shell.plugins

Class PluginResourceBean

java.lang.Object

org.carewebframework.shell.plugins.PluginResourceBean

All Implemented Interfaces:

IPluginResource

public class PluginResourceBean
extends Object
implements IPluginResource

Resource for declaring helper beans associated with the plugin.

Constructor Summary

Constructors

Constructor and Description
PluginResourceBean()

Method Summary

Modifier and Type	Method and Description
String	getBean() Gets the id of the referenced bean.
boolean	isRequired() Returns whether or not the reference bean is required.
void	register(CareWebShell shell, ElementBase owner, boolean register) Registers/unregisters a bean resource.
void	setBean(String bean) Sets the referenced bean by its id.
void	setRequired(boolean required) Sets whether or not the reference bean is required.

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginResourceBean

public PluginResourceBean()

Method Detail

setBean

public void setBean(String bean)

Sets the referenced bean by its id.

Parameters:

bean - The bean id.

getBean

public String getBean()

Gets the id of the referenced bean.

Returns:

The bean id.

setRequired

public void setRequired(boolean required)

Sets whether or not the reference bean is required.

Parameters:

required - If true and the bean is not found, an exception is raised.

isRequired

public boolean isRequired()

Returns whether or not the reference bean is required.

Returns:

If true and the bean is not found, an exception is raised.

register

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

Registers/unregisters a bean 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.