PluginDefinition (CWF Shell 6.0.0-RC3 API)

java.lang.Object
- org.carewebframework.shell.plugins.PluginDefinition

```
public class PluginDefinition
extends Object
```
Each instance of this class defines a complete definition of a CareWeb plugin. A definition declares various attributes of a plugin, like its display name, url, toolbar buttons, help module, etc.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class PluginDefinition.Authority
Represents a security authority.

Nested Classes
Modifier and Type	Class and Description
`static class`	`PluginDefinition.Authority` Represents a security authority.

Constructor Summary

Constructors
Constructor and Description
`PluginDefinition()` The basic constructor.
`PluginDefinition(PluginDefinition def)` Copy constructor.
`PluginDefinition(String id, String name, Class<? extends ElementBase> clazz)` Constructs a plugin definition for the specified plugin id, name and class.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ElementBase`	`createElement(ElementBase parent, org.carewebframework.api.property.IPropertyProvider propertyProvider, boolean deserializing)` Creates an instance of the element based on its definition.
`List<PluginDefinition.Authority>`	`getAuthorities()` Returns the list of authorities required for access to this plugin.
`String`	`getCategory()` Returns the category under which this plugin is to be classified.
`Class<? extends ElementBase>`	`getClazz()` Returns the UI element class associated with this definition.
`String`	`getCopyright()` Returns any copyright information for this plugin.
`String`	`getCreator()` Returns the name of the creator of this plugin.
`static PluginDefinition`	`getDefinition(Class<? extends ElementBase> clazz)` Returns the plugin definition associated with the specified class.
`static PluginDefinition`	`getDefinition(String tag)` Returns the plugin definition associated with the specified xml tag (same as plugin id).
`String`	`getDescription()` Returns the description of this plugin.
`String`	`getIcon()` Returns the url of the icon associated with the plugin.
`String`	`getId()` Returns the unique id of the plugin definition.
`String`	`getName()` Returns the display name of the plugin definition.
`List<PropertyInfo>`	`getProperties()` Returns the list of properties associated with this plugin.
`String`	`getReleased()` Returns release information (typically a date) about the plugin.
`List<IPluginResource>`	`getResources()` Returns the list of associated plugin resources.
`<E extends IPluginResource> List<E>`	`getResources(Class<E> clazz)` Returns the list of plugin resources belonging to the specified resource class.
`String`	`getSource()` Returns the source of the plugin.
`String`	`getUrl()` Returns the URL of the principal cwf page for the plugin.
`String`	`getVersion()` Returns version information about the plugin.
`boolean`	`hasEditableProperties()` Returns true if this definition contains any editable properties.
`void`	`initElement(ElementBase element, org.carewebframework.api.property.IPropertyProvider propertyProvider)` Initialize the element's properties using the specified property provider.
`boolean`	`isDisabled()` Returns true if the plugin has been disabled.
`boolean`	`isForbidden()` Returns true if access to the plugin is restricted.
`boolean`	`isInternal()` Returns true if this definition represents an internal UI element (i.e., one that has been pre-created by some other means).
`boolean`	`isLazyLoad()` Returns the lazyLoad flag.
`boolean`	`isRequiresAll()` Returns the requiresAll flag.
`void`	`setAuthorities(List<PluginDefinition.Authority> authorities)` Adds authorities from the list to the list of authorities associated with this plugin.
`void`	`setCategory(String category)` Sets the category under which this plugin is to be classified.
`void`	`setClazz(Class<? extends ElementBase> clazz)` Sets the UI element class associated with this definition.
`void`	`setCopyright(String copyright)` Sets any copyright information for this plugin.
`void`	`setCreator(String creator)` Sets the name of the creator of this plugin.
`void`	`setDescription(String description)` Sets the description of this plugin.
`void`	`setDisabled(boolean disabled)` Sets the disabled state of the plugin.
`void`	`setIcon(String icon)` Sets the url of the icon associated with the plugin.
`void`	`setId(String id)` Sets the unique id of the plugin definition
`void`	`setLazyLoad(boolean lazyLoad)` Sets the lazyLoad flag.
`void`	`setName(String name)` Sets the display name of the plugin definition.
`void`	`setPath(String path)` Sets the path of the resource containing the plugin definition.
`void`	`setProperties(List<PropertyInfo> properties)` Adds properties from the list to the list of properties associated with this plugin.
`void`	`setReleased(String released)` Sets release information (typically a date) about the plugin.
`void`	`setRequiresAll(boolean requiresAll)` Sets the requiresAll flag.
`void`	`setResources(List<IPluginResource> resources)` Adds resources from the list to the list of resources associated with this plugin.
`void`	`setSource(String source)` Sets the source of the plugin.
`void`	`setUrl(String url)` Sets the URL of the principal cwf page for the plugin.
`void`	`setVersion(String version)` Sets version information about the plugin.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PluginDefinition
```
public PluginDefinition()
```
    The basic constructor.
  - PluginDefinition
```
public PluginDefinition(String id,
                        String name,
                        Class<? extends ElementBase> clazz)
```
    Constructs a plugin definition for the specified plugin id, name and class.
    
    Parameters:
    
    id - Unique id for plugin
    
    name - Display name of the plugin.
    
    clazz - Associated UI element class.
  - PluginDefinition
```
public PluginDefinition(PluginDefinition def)
```
    Copy constructor.
    
    Parameters:
    
    def - Plugin definition to copy.
- Method Detail
  - getDefinition
```
public static PluginDefinition getDefinition(String tag)
```
    Returns the plugin definition associated with the specified xml tag (same as plugin id).
    
    Parameters:
    
    tag - XML tag (plugin id).
    
    Returns:
    
    The associated plugin definition, or null if not found.
  - getDefinition
```
public static PluginDefinition getDefinition(Class<? extends ElementBase> clazz)
```
    Returns the plugin definition associated with the specified class.
    
    Parameters:
    
    clazz - The class whose plugin definition is sought.
    
    Returns:
    
    The associated plugin definition, or null if not found.
  - getId
```
public String getId()
```
    Returns the unique id of the plugin definition.
    
    Returns:
    
    The unique id.
  - setId
```
public void setId(String id)
```
    Sets the unique id of the plugin definition
    
    Parameters:
    
    id - The unique plugin id.
  - getSource
```
public String getSource()
```
    Returns the source of the plugin.
    
    Returns:
    
    The plugin source.
  - setSource
```
public void setSource(String source)
```
    Sets the source of the plugin.
    
    Parameters:
    
    source - Plugin source.
  - getName
```
public String getName()
```
    Returns the display name of the plugin definition.
    
    Returns:
    
    The display name.
  - setName
```
public void setName(String name)
```
    Sets the display name of the plugin definition.
    
    Parameters:
    
    name - Plugin display name.
  - getUrl
```
public String getUrl()
```
    Returns the URL of the principal cwf page for the plugin.
    
    Returns:
    
    The URL of the principal cwf page.
  - setUrl
```
public void setUrl(String url)
```
    Sets the URL of the principal cwf page for the plugin.
    
    Parameters:
    
    url - The URL of the principal cwf page.
  - setRequiresAll
```
public void setRequiresAll(boolean requiresAll)
```
    Sets the requiresAll flag. When true, this flag indicates that all associated authorities must be present in order to access the plugin. When false, any single associated authority is sufficient for access. If no authorities are associated with the plugin, this setting is ignored.
    
    Parameters:
    
    requiresAll - The requiresAll flag.
  - isRequiresAll
```
public boolean isRequiresAll()
```
    Returns the requiresAll flag. When true, this flag indicates that all associated authorities must be present in order to access the plugin. When false, any single associated authority is sufficient for access. If no authorities are associated with the plugin, this setting is ignored.
    
    Returns:
    
    The requiresAll flag.
  - isLazyLoad
```
public boolean isLazyLoad()
```
    Returns the lazyLoad flag. When true, a plugin created from this definition is not fully initialized until it is first activity. When false, the plugin is initialized immediately after deserialization.
    
    Returns:
    
    The lazyLoad flag.
  - setLazyLoad
```
public void setLazyLoad(boolean lazyLoad)
```
    Sets the lazyLoad flag. When true, a plugin created from this definition is not fully initialized until it is first activity. When false, the plugin is initialized immediately after deserialization.
    
    Parameters:
    
    lazyLoad - The lazyLoad flag.
  - getResources
```
public List<IPluginResource> getResources()
```
    Returns the list of associated plugin resources. Never null.
    
    Returns:
    
    List of associated resources.
  - getResources
```
public <E extends IPluginResource> List<E> getResources(Class<E> clazz)
```
    Returns the list of plugin resources belonging to the specified resource class. Never null.
    
    Type Parameters:
    
    E - A subclass of PluginResource.
    
    Parameters:
    
    clazz - The resource class being sought.
    
    Returns:
    
    List of associated resources.
  - setResources
```
public void setResources(List<IPluginResource> resources)
```
    Adds resources from the list to the list of resources associated with this plugin.
    
    Parameters:
    
    resources - Resources to add.
  - getAuthorities
```
public List<PluginDefinition.Authority> getAuthorities()
```
    Returns the list of authorities required for access to this plugin. Never null.
    
    Returns:
    
    List of authorities.
  - setAuthorities
```
public void setAuthorities(List<PluginDefinition.Authority> authorities)
```
    Adds authorities from the list to the list of authorities associated with this plugin.
    
    Parameters:
    
    authorities - Authorities required by this plugin.
  - getProperties
```
public List<PropertyInfo> getProperties()
```
    Returns the list of properties associated with this plugin. Never null.
    
    Returns:
    
    List of properties.
  - setProperties
```
public void setProperties(List<PropertyInfo> properties)
```
    Adds properties from the list to the list of properties associated with this plugin.
    
    Parameters:
    
    properties - List of associated properties.
  - getClazz
```
public Class<? extends ElementBase> getClazz()
```
    Returns the UI element class associated with this definition.
    
    Returns:
    
    Associated UI element class.
  - setClazz
```
public void setClazz(Class<? extends ElementBase> clazz)
```
    Sets the UI element class associated with this definition.
    
    Parameters:
    
    clazz - The associated class.
  - getDescription
```
public String getDescription()
```
    Returns the description of this plugin.
    
    Returns:
    
    Plugin description.
  - setDescription
```
public void setDescription(String description)
```
    Sets the description of this plugin.
    
    Parameters:
    
    description - The plugin description.
  - setCategory
```
public void setCategory(String category)
```
    Sets the category under which this plugin is to be classified. This can be specified as a tree node path using "\" to separate the path components.
    
    Parameters:
    
    category - The plugin category.
  - getCategory
```
public String getCategory()
```
    Returns the category under which this plugin is to be classified. This can be specified as a tree node path using "\" to separate the path components.
    
    Returns:
    
    Associated category.
  - getCreator
```
public String getCreator()
```
    Returns the name of the creator of this plugin.
    
    Returns:
    
    Plugin creator.
  - setCreator
```
public void setCreator(String creator)
```
    Sets the name of the creator of this plugin.
    
    Parameters:
    
    creator - The plugin creator.
  - getCopyright
```
public String getCopyright()
```
    Returns any copyright information for this plugin.
    
    Returns:
    
    Copyright info.
  - setCopyright
```
public void setCopyright(String copyright)
```
    Sets any copyright information for this plugin.
    
    Parameters:
    
    copyright - Plugin copyright information.
  - getVersion
```
public String getVersion()
```
    Returns version information about the plugin.
    
    Returns:
    
    Version info.
  - setVersion
```
public void setVersion(String version)
```
    Sets version information about the plugin.
    
    Parameters:
    
    version - The plugin version.
  - setReleased
```
public void setReleased(String released)
```
    Sets release information (typically a date) about the plugin.
    
    Parameters:
    
    released - Release information.
  - getReleased
```
public String getReleased()
```
    Returns release information (typically a date) about the plugin.
    
    Returns:
    
    Release info.
  - setIcon
```
public void setIcon(String icon)
```
    Sets the url of the icon associated with the plugin.
    
    Parameters:
    
    icon - Url of an icon.
  - getIcon
```
public String getIcon()
```
    Returns the url of the icon associated with the plugin.
    
    Returns:
    
    Url of associated icon.
  - isInternal
```
public boolean isInternal()
```
    Returns true if this definition represents an internal UI element (i.e., one that has been pre-created by some other means).
    
    Returns:
    
    True if internal element.
  - isDisabled
```
public boolean isDisabled()
```
    Returns true if the plugin has been disabled.
    
    Returns:
    
    True if disabled.
  - setDisabled
```
public void setDisabled(boolean disabled)
```
    Sets the disabled state of the plugin.
    
    Parameters:
    
    disabled - The desired state.
  - isForbidden
```
public boolean isForbidden()
```
    Returns true if access to the plugin is restricted.
    
    Returns:
    
    True if access to the plugin is restricted.
  - hasEditableProperties
```
public boolean hasEditableProperties()
```
    Returns true if this definition contains any editable properties.
    
    Returns:
    
    True if editable properties are present.
  - setPath
```
public void setPath(String path)
```
    Sets the path of the resource containing the plugin definition. This is used to locate the manifest entry from which version and source information can be extracted.
    
    Parameters:
    
    path - Path of the resource containing this plugin definition.
  - createElement
```
public ElementBase createElement(ElementBase parent,
                                 org.carewebframework.api.property.IPropertyProvider propertyProvider,
                                 boolean deserializing)
```
    Creates an instance of the element based on its definition. If a property source is specified, the source is used to initialize properties on the newly created element.
    
    Parameters:
    
    parent - Parent element (may be null).
    
    propertyProvider - Property source for initializing element properties (may be null).
    
    deserializing - If true, we are deserializing a layout.
    
    Returns:
    
    Newly created element (may be null if access is restricted or plugin has been disabled).
  - initElement
```
public void initElement(ElementBase element,
                        org.carewebframework.api.property.IPropertyProvider propertyProvider)
```
    Initialize the element's properties using the specified property provider.
    
    Parameters:
    
    element - Element to initialize.
    
    propertyProvider - Provider of property values.

Class PluginDefinition

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PluginDefinition

PluginDefinition

PluginDefinition

Method Detail

getDefinition

getDefinition

getId

setId

getSource

setSource

getName

setName

getUrl

setUrl

setRequiresAll

isRequiresAll

isLazyLoad

setLazyLoad

getResources

getResources

setResources

getAuthorities

setAuthorities

getProperties

setProperties

getClazz

setClazz

getDescription

setDescription

setCategory

getCategory

getCreator

setCreator

getCopyright

setCopyright

getVersion

setVersion

setReleased

getReleased

setIcon

getIcon

isInternal

isDisabled

setDisabled

isForbidden

hasEditableProperties

setPath

createElement

initElement