Class PluginTypeData

    • Field Detail

      • description

        private String description
      • removedBy

        private Integer removedBy
      • entryDate

        private Date entryDate
      • MAX_INTERFACENAME_LENGTH

        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
      • jarFile

        private String jarFile
    • Constructor Detail

      • PluginTypeData

        public PluginTypeData()
    • Method Detail

      • getName

        public String getName()
        Description copied from interface: NameableData
        Get the name of the item.
        Specified by:
        getName in interface NameableData
        Returns:
        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
        Parameters:
        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
        Returns:
        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
        Parameters:
        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
        Returns:
        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).
        Returns:
        The class name for this plugin
        Since:
        3.0
        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:
        PluginDefinitionData.getPluginTypes()
        Hibernate: set
        table="`PluginDefinitionTypes`" lazy="true"
        Hibernate: collection-key
        column="`plugintype_id`"
        Hibernate: collection-many-to-many
        column="`plugindefinition_id`" class="net.sf.basedb.core.data.PluginDefinitionData"