Overview  Package   Class  Deprecated  Index  Help 
Groovy Documentation
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.adaptc.mws.plugins
[Java] Class AbstractPluginInfo

java.lang.Object
  com.adaptc.mws.plugins.AbstractPluginInfo

public abstract class AbstractPluginInfo
extends Object

Base class for plugin information. This is used internally and should not be extended directly.

Authors:
bsaville

Field Summary
private String id

 
Constructor Summary
AbstractPluginInfo()

 
Method Summary
Boolean getAutoStart()

Retrieves whether or not the plugin starts automatically on initialization.
Map getConfig()

Retrieves the current configuration of the plugin as a Map of key-value pairs.
String getId()

Retrieves the unique identifier for the plugin.
String getPluginType()

Retrieves the plugin type, as in "Native".
Integer getPollInterval()

Retrieves the current polling interval of the plugin in seconds.
PluginState getState()

Retrieves the current state of the Plugin.
String getSubstate()

Retrieves the current substate of the Plugin.

void setId(String id)

Sets the unique identifier for the plugin.
 
Methods inherited from class Object
wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll
 

Field Detail

id

private String id

 
Constructor Detail

AbstractPluginInfo

AbstractPluginInfo()

 
Method Detail

getAutoStart

public Boolean getAutoStart()
Retrieves whether or not the plugin starts automatically on initialization.
Returns:
True if starts automatically, false otherwise

getConfig

public Map getConfig()
Retrieves the current configuration of the plugin as a Map of key-value pairs.
Returns:
A map of key-value pairs representing the configuration

getId

public String getId()
Retrieves the unique identifier for the plugin.
Returns:
The unique ID

getPluginType

public String getPluginType()
Retrieves the plugin type, as in "Native".
Returns:
The plugin type name (without the "Plugin" suffix)

getPollInterval

public Integer getPollInterval()
Retrieves the current polling interval of the plugin in seconds.
Returns:
The polling interval in seconds

getState

public PluginState getState()
Retrieves the current state of the Plugin.
Returns:
The current state

getSubstate

public String getSubstate()
Retrieves the current substate of the Plugin. This can signify the reason for an errored state or a description providing more information than that of the "state" field.
Returns:
The current substate

setId

public void setId(String id)
Sets the unique identifier for the plugin.
Parameters:
id - The new ID to set

 

Groovy Documentation