Class PluginTypeData

All Implemented Interfaces:
IdentifiableData, NameableData, RegisteredData, RemovableData

public class PluginTypeData
extends BasicData
implements NameableData, RemovableData, RegisteredData
This class represent an interface that a plugin can implement.
See Also:
PluginType, Developer documentation: Plug-ins, jobs and job agents
Last modified
$Date: 2015-11-17 13:57:57 +0100 (ti, 17 nov 2015) $
Hibernate: class
table="`PluginTypes`" lazy="false"
  • Field Details

    • name

      private String name
    • description

      private String description
    • removedBy

      private Integer removedBy
    • entryDate

      private Date entryDate

      public static final int MAX_INTERFACENAME_LENGTH
      The maximum length of the interface name that can be stored in the database.
      See Also:
      Constant Field Values
    • interfaceName

      private String interfaceName

      public static final int MAX_JARFILE_LENGTH
      See Also:
      Constant Field Values
    • jarFile

      private String jarFile
    • plugins

      private Set<PluginDefinitionData> plugins
  • Constructor Details

    • PluginTypeData

      public PluginTypeData()
  • Method Details

    • getName

      public String getName()
      Description copied from interface: NameableData
      Get the name of the item.
      Specified by:
      getName in interface NameableData
      A String with the name of the item
    • setName

      public void setName​(String name)
      Description copied from interface: NameableData
      Set the name of the item. The name cannot be null and mustn't be longer than the value specified by the MAX_NAME_LENGTH constant.
      Specified by:
      setName in interface NameableData
      name - The new name for the item
    • getDescription

      public String getDescription()
      Description copied from interface: NameableData
      Get the description for the item.
      Specified by:
      getDescription in interface NameableData
      A String with a description of the item
    • setDescription

      public void setDescription​(String description)
      Description copied from interface: NameableData
      Set the description for the item. The description can be null but mustn't be longer than the value specified by the MAX_DESCRIPTION_LENGTH constant.
      Specified by:
      setDescription in interface NameableData
      description - The new description for the item
    • getRemovedBy

      public Integer getRemovedBy()
      Description copied from interface: RemovableData
      Get the ID of the user that removed this item.
      Specified by:
      getRemovedBy in interface RemovableData
      The ID of a user or null if the item is not removed
    • setRemovedBy

      public void setRemovedBy​(Integer removedBy)
      Description copied from interface: RemovableData
      Set the ID of the user that removed this item or null to restore the item.
      Specified by:
      setRemovedBy in interface RemovableData
    • getEntryDate

      public Date getEntryDate()
      Description copied from interface: RegisteredData
      Get the date this item was added to the database. The value is generated at creation time and can't be modified later.
      Specified by:
      getEntryDate in interface RegisteredData
    • setEntryDate

      public void setEntryDate​(Date entryDate)
    • getInterfaceName

      public String getInterfaceName()
      Get the interface name a plugin must implement to be of this type. The specified interface must extend the Plugin interface.
      Hibernate: property
      column="`interface_name`" type="string" length="255" not-null="true" unique="true"
    • setInterfaceName

      public void setInterfaceName​(String interfaceName)
    • getJarFile

      public String getJarFile()
      Get the file name of the JAR file where the plugin class is located. The JAR file must be located in the 'plugins.dir' folder specified in base.config. If the value is null the plugin must be in the classpath (eg. WEB-INF/lib).
      The class name for this plugin
      Hibernate: property
      column="`jar_file`" type="string" length="255" not-null="false"
    • setJarFile

      public void setJarFile​(String jarFile)
    • getPlugins

      Set<PluginDefinitionData> getPlugins()
      The plugin implementing this interface. This is the inverse end.
      See Also:
      Hibernate: set
      table="`PluginDefinitionTypes`" lazy="true"
      Hibernate: collection-key
      Hibernate: collection-many-to-many
      column="`plugindefinition_id`" class=""
    • setPlugins

      void setPlugins​(Set<PluginDefinitionData> plugins)