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

com.ace.mws.plugins
[Groovy] Class PluginType

java.lang.Object
  com.ace.mws.plugins.PluginType

class PluginType

Represents a MWS plugin type. All fields in this class are generated from plugin project and type metadata and cannot be modified directly. Consequentially, all fields are only valid for list/show/GET operations.

Authors:
bsaville

Field Summary
private String author

The main author (company or person) of the plugin type.
private String commonsVersion

A string representing the restriction on which version of the plugin framework (plugins-commons dependency) is required for the plugin type.

private String description

The full description of the plugin type.
private String documentationLink

A full URL to the complete documentation for the plugin type.
private String email

The email of the author.
private String id

The unique identifier of the plugin type.

private Map initialPlugins

(Map of String => PluginInstance) Represents the plugins that are initially configured when the plugin type is loaded.

private String issueManagementLink

A full URL to the issue management system or project for the plugin type.
private String license

The license of this plugin type, typically APACHE.
private String mwsVersion

A string representing the restriction on which version of MWS is required for the plugin type.

private boolean pollMethod

Indicates whether the plugin type has a defined 'poll' method (event handler) or not.
private String scmLink

A full URL to the Source Control Management (SCM) system or project for the plugin type.
private String title

A short name describing the plugin type.
private String website

The website of the author.
 
Constructor Summary
PluginType()

 
Method Summary
String getAuthor()

The main author (company or person) of the plugin type.
String getCommonsVersion()

A string representing the restriction on which version of the plugin framework (plugins-commons dependency) is required for the plugin type.

String getDescription()

The full description of the plugin type.
String getDocumentationLink()

A full URL to the complete documentation for the plugin type.
String getEmail()

The email of the author.
String getId()

The unique identifier of the plugin type.

Map getInitialPlugins()

(Map of String => PluginInstance) Represents the plugins that are initially configured when the plugin type is loaded.

String getIssueManagementLink()

A full URL to the issue management system or project for the plugin type.
String getLicense()

The license of this plugin type, typically APACHE.
String getMwsVersion()

A string representing the restriction on which version of MWS is required for the plugin type.

boolean getPollMethod()

Indicates whether the plugin type has a defined 'poll' method (event handler) or not.
String getScmLink()

A full URL to the Source Control Management (SCM) system or project for the plugin type.
String getTitle()

A short name describing the plugin type.
String getWebsite()

The website of the author.
void setAuthor(String author)

The main author (company or person) of the plugin type.
void setCommonsVersion(String commonsVersion)

A string representing the restriction on which version of the plugin framework (plugins-commons dependency) is required for the plugin type.

void setDescription(String description)

The full description of the plugin type.
void setDocumentationLink(String documentationLink)

A full URL to the complete documentation for the plugin type.
void setEmail(String email)

The email of the author.
void setId(String id)

The unique identifier of the plugin type.

void setInitialPlugins(Map initialPlugins)

(Map of String => PluginInstance) Represents the plugins that are initially configured when the plugin type is loaded.

void setIssueManagementLink(String issueManagementLink)

A full URL to the issue management system or project for the plugin type.
void setLicense(String license)

The license of this plugin type, typically APACHE.
void setMwsVersion(String mwsVersion)

A string representing the restriction on which version of MWS is required for the plugin type.

void setPollMethod(boolean pollMethod)

Indicates whether the plugin type has a defined 'poll' method (event handler) or not.
void setScmLink(String scmLink)

A full URL to the Source Control Management (SCM) system or project for the plugin type.
void setTitle(String title)

A short name describing the plugin type.
void setWebsite(String website)

The website of the author.
String toString()

 
Methods inherited from class Object
wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll
 

Field Detail

author

private String author
The main author (company or person) of the plugin type.

commonsVersion

private String commonsVersion
A string representing the restriction on which version of the plugin framework (plugins-commons dependency) is required for the plugin type. In the format 'COMMONS_VERSION > *', meaning that any version greater or equal to COMMONS_VERSION is valid.

description

private String description
The full description of the plugin type.

documentationLink

private String documentationLink
A full URL to the complete documentation for the plugin type.

email

private String email
The email of the author.

id

private String id
The unique identifier of the plugin type. This is based on the class name of the plugin. Ex:

Plugin Class Name -> ID
NativePlugin -> Native
MSMPlugin -> MSM
MyExamplePlugin -> MyExample

initialPlugins

private Map initialPlugins
(Map of String => PluginInstance) Represents the plugins that are initially configured when the plugin type is loaded. Each key represents the plugin ID.
See Also:
Map

issueManagementLink

private String issueManagementLink
A full URL to the issue management system or project for the plugin type.

license

private String license
The license of this plugin type, typically APACHE.

mwsVersion

private String mwsVersion
A string representing the restriction on which version of MWS is required for the plugin type. In the format 'MWS_VERSION > *', meaning that any version greater or equal to MWS_VERSION is valid.

pollMethod

private boolean pollMethod
Indicates whether the plugin type has a defined 'poll' method (event handler) or not.

scmLink

private String scmLink
A full URL to the Source Control Management (SCM) system or project for the plugin type.

title

private String title
A short name describing the plugin type.

website

private String website
The website of the author.

 
Constructor Detail

PluginType

PluginType()

 
Method Detail

getAuthor

String getAuthor()
The main author (company or person) of the plugin type.

getCommonsVersion

String getCommonsVersion()
A string representing the restriction on which version of the plugin framework (plugins-commons dependency) is required for the plugin type. In the format 'COMMONS_VERSION > *', meaning that any version greater or equal to COMMONS_VERSION is valid.

getDescription

String getDescription()
The full description of the plugin type.

getDocumentationLink

String getDocumentationLink()
A full URL to the complete documentation for the plugin type.

getEmail

String getEmail()
The email of the author.

getId

String getId()
The unique identifier of the plugin type. This is based on the class name of the plugin. Ex:

Plugin Class Name -> ID
NativePlugin -> Native
MSMPlugin -> MSM
MyExamplePlugin -> MyExample

getInitialPlugins

Map getInitialPlugins()
(Map of String => PluginInstance) Represents the plugins that are initially configured when the plugin type is loaded. Each key represents the plugin ID.
See Also:
Map

getIssueManagementLink

String getIssueManagementLink()
A full URL to the issue management system or project for the plugin type.

getLicense

String getLicense()
The license of this plugin type, typically APACHE.

getMwsVersion

String getMwsVersion()
A string representing the restriction on which version of MWS is required for the plugin type. In the format 'MWS_VERSION > *', meaning that any version greater or equal to MWS_VERSION is valid.

getPollMethod

boolean getPollMethod()
Indicates whether the plugin type has a defined 'poll' method (event handler) or not.

getScmLink

String getScmLink()
A full URL to the Source Control Management (SCM) system or project for the plugin type.

getTitle

String getTitle()
A short name describing the plugin type.

getWebsite

String getWebsite()
The website of the author.

setAuthor

void setAuthor(String author)
The main author (company or person) of the plugin type.

setCommonsVersion

void setCommonsVersion(String commonsVersion)
A string representing the restriction on which version of the plugin framework (plugins-commons dependency) is required for the plugin type. In the format 'COMMONS_VERSION > *', meaning that any version greater or equal to COMMONS_VERSION is valid.

setDescription

void setDescription(String description)
The full description of the plugin type.

setDocumentationLink

void setDocumentationLink(String documentationLink)
A full URL to the complete documentation for the plugin type.

setEmail

void setEmail(String email)
The email of the author.

setId

void setId(String id)
The unique identifier of the plugin type. This is based on the class name of the plugin. Ex:

Plugin Class Name -> ID
NativePlugin -> Native
MSMPlugin -> MSM
MyExamplePlugin -> MyExample

setInitialPlugins

void setInitialPlugins(Map initialPlugins)
(Map of String => PluginInstance) Represents the plugins that are initially configured when the plugin type is loaded. Each key represents the plugin ID.
See Also:
Map

setIssueManagementLink

void setIssueManagementLink(String issueManagementLink)
A full URL to the issue management system or project for the plugin type.

setLicense

void setLicense(String license)
The license of this plugin type, typically APACHE.

setMwsVersion

void setMwsVersion(String mwsVersion)
A string representing the restriction on which version of MWS is required for the plugin type. In the format 'MWS_VERSION > *', meaning that any version greater or equal to MWS_VERSION is valid.

setPollMethod

void setPollMethod(boolean pollMethod)
Indicates whether the plugin type has a defined 'poll' method (event handler) or not.

setScmLink

void setScmLink(String scmLink)
A full URL to the Source Control Management (SCM) system or project for the plugin type.

setTitle

void setTitle(String title)
A short name describing the plugin type.

setWebsite

void setWebsite(String website)
The website of the author.

toString

String toString()

 

Groovy Documentation