pt.ua.dicoogle.plugins.webui

Class WebUIPlugin

java.lang.Object

pt.ua.dicoogle.plugins.webui.WebUIPlugin

All Implemented Interfaces:

java.lang.Cloneable

public class WebUIPlugin
extends java.lang.Object
implements java.lang.Cloneable

A POJO data type containing the full description of a Web UI plugin.

Constructor Summary

Constructors

Constructor and Description
WebUIPlugin()

Method Summary

Modifier and Type	Method and Description
protected WebUIPlugin	clone()
WebUIPlugin	copy() Make a copy of the descriptor.
static WebUIPlugin	fromPackageJSON(JSONObject obj) Retrieve a web UI plugin descriptor out of the contents of a "package.json".
java.lang.String	getCaption()
java.lang.String	getDescription()
java.lang.String	getModuleFile()
java.lang.String	getName()
java.util.Set<java.lang.String>	getRoles()
JSONObject	getSettings() Getter for the plugin's settings.
java.lang.String	getSlotId()
java.lang.String	getVersion()
boolean	isEnabled()
void	setCaption(java.lang.String caption)
void	setDescription(java.lang.String description)
void	setEnabled(boolean enabled)
void	setModuleFile(java.lang.String moduleFile)
void	setName(java.lang.String name)
void	setSettings(JSONObject holder)
void	setSlotId(java.lang.String slotId)
void	setVersion(java.lang.String version)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

WebUIPlugin

public WebUIPlugin()

Method Detail

clone

protected WebUIPlugin clone()
                     throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

copy

public WebUIPlugin copy()

Make a copy of the descriptor.

Returns:

a copy of this descriptor

fromPackageJSON

public static WebUIPlugin fromPackageJSON(JSONObject obj)
                                   throws PluginFormatException

Retrieve a web UI plugin descriptor out of the contents of a "package.json".

Parameters:

obj - a JSON object of the plugin description

Returns:

a web UI plugin descriptor out of the JSON object

Throws:

PluginFormatException - if the JSON text contains bad information, or not enough of it

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getVersion

public java.lang.String getVersion()

setVersion

public void setVersion(java.lang.String version)

getSlotId

public java.lang.String getSlotId()

setSlotId

public void setSlotId(java.lang.String slotId)

getModuleFile

public java.lang.String getModuleFile()

setModuleFile

public void setModuleFile(java.lang.String moduleFile)

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String description)

setSettings

public void setSettings(JSONObject holder)

getSettings

public JSONObject getSettings()

Getter for the plugin's settings.

Returns:

a JSON object containing the settings, empty object if no settings are stored

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getCaption

public java.lang.String getCaption()

setCaption

public void setCaption(java.lang.String caption)

getRoles

public java.util.Set<java.lang.String> getRoles()