Package net.sf.basedb.core.data
Class PluginConfigurationData
java.lang.Object
net.sf.basedb.core.data.BasicData
net.sf.basedb.core.data.OwnedData
net.sf.basedb.core.data.SharedData
net.sf.basedb.core.data.CommonData
net.sf.basedb.core.data.AnnotatedData
net.sf.basedb.core.data.PluginConfigurationData
- All Implemented Interfaces:
AnnotatableData
,IdentifiableData
,LoggableData
,NameableData
,OwnableData
,RegisteredData
,RemovableData
,ShareableData
public class PluginConfigurationData extends AnnotatedData implements RegisteredData
This data class is used to configure a plugin. A plugin can have many
configurations.
- Version:
- 2.0
- Author:
- Nicklas, Samuel
- See Also:
PluginConfiguration
, Developer documentation: Plug-ins, jobs and job agents- Hibernate: class
- table="`PluginConfigurations`" lazy="false"
-
Field Summary
Fields Modifier and Type Field Description private Map<VersionedParameter,ParameterValueData<?>>
configurationValues
private boolean
disabled
private Date
entryDate
private int
parameterVersion
private PluginDefinitionData
pluginDefinition
Fields inherited from interface net.sf.basedb.core.data.NameableData
MAX_DESCRIPTION_LENGTH, MAX_NAME_LENGTH
-
Constructor Summary
Constructors Constructor Description PluginConfigurationData()
-
Method Summary
Modifier and Type Method Description Map<VersionedParameter,ParameterValueData<?>>
getConfigurationValues()
Used by Hibernate to link with configuration values.Date
getEntryDate()
Get the date this item was added to the database.int
getParameterVersion()
Get the current/latest parameter version.PluginDefinitionData
getPluginDefinition()
Get the plugin definition for this configuration.boolean
isDisabled()
If the plugin is enabled or disabled. // Mapped in hibernate-properties-PluginConfigurationData.xml since annotation doesn't support a default value(package private) void
setConfigurationValues(Map<VersionedParameter,ParameterValueData<?>> configurationValues)
void
setDisabled(boolean disabled)
void
setEntryDate(Date entryDate)
void
setParameterVersion(int parameterVersion)
void
setPluginDefinition(PluginDefinitionData pd)
Methods inherited from class net.sf.basedb.core.data.AnnotatedData
getAnnotations, getAnnotationSet, setAnnotations, setAnnotationSet
Methods inherited from class net.sf.basedb.core.data.CommonData
getDescription, getName, getRemovedBy, setDescription, setName, setRemovedBy
Methods inherited from class net.sf.basedb.core.data.SharedData
getItemKey, getProjectKey, setItemKey, setProjectKey
Methods inherited from class net.sf.basedb.core.data.BasicData
equals, getId, getVersion, hashCode, setId, setVersion, toString
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface net.sf.basedb.core.data.IdentifiableData
getId, getVersion
Methods inherited from interface net.sf.basedb.core.data.OwnableData
getOwner, setOwner
-
Field Details
-
entryDate
-
disabled
private boolean disabled -
pluginDefinition
-
parameterVersion
private int parameterVersion -
configurationValues
-
-
Constructor Details
-
PluginConfigurationData
public PluginConfigurationData()
-
-
Method Details
-
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 interfaceRegisteredData
-
setEntryDate
-
isDisabled
public boolean isDisabled()If the plugin is enabled or disabled. // Mapped in hibernate-properties-PluginConfigurationData.xml since annotation doesn't support a default value- Since:
- 3.19.6
-
setDisabled
public void setDisabled(boolean disabled) -
getPluginDefinition
Get the plugin definition for this configuration.- Returns:
- A
PluginDefinition
object. - Hibernate: many-to-one
- column="`plugindefinition_id`" not-null="true" update="false"
-
setPluginDefinition
-
getParameterVersion
public int getParameterVersion()Get the current/latest parameter version.- Hibernate: property
- column="`parameter_version`" type="int" not-null="true"
-
setParameterVersion
public void setParameterVersion(int parameterVersion) -
getConfigurationValues
Used by Hibernate to link with configuration values.- Hibernate: map
- table="`VersionedPluginConfigurationValues`" lazy="true" cascade="all"
- Hibernate: collection-key
- column="`pluginconfiguration_id`"
- Hibernate: collection-composite-index
- class="net.sf.basedb.core.data.VersionedParameter"
- Hibernate: collection-many-to-many
- column="`value_id`" class="net.sf.basedb.core.data.ParameterValueData"
-
setConfigurationValues
-