Interface SystemProperty
- All Superinterfaces:
MultiTenantCloneable<SystemProperty>,Serializable
- All Known Implementing Classes:
NullSystemProperty,SystemPropertyImpl
This interface represents a System Property (name/value pair) stored in the database.
User: Kelly Tisdell
Date: 6/20/12
-
Method Summary
Modifier and TypeMethodDescriptiongetId()Unique id of the DB recordgetName()The name of the property as it exists in property files (for example googleAnalytics.webPropertyId)Declares whether or not the property name has been overridden, rather than using the default generated value.Returns the property field type.getValue()Returns the property value.voidsetFriendlyGroup(String friendlyGroup) Sets the friendly group name of this propertyvoidsetFriendlyName(String friendlyName) Sets the friendly name of this propertyvoidsetFriendlyTab(String friendlyTab) Sets the friendly tab of this propertyvoidSets the id of the DB recordvoidSets the property name.voidsetOverrideGeneratedPropertyName(Boolean overrideGeneratedPropertyName) Sets the overrideGeneratedPropertyName.voidSets the property field type.voidSets the property value.Methods inherited from interface org.broadleafcommerce.common.copy.MultiTenantCloneable
createOrRetrieveCopyInstance
-
Method Details
-
getId
Long getId()Unique id of the DB record- Returns:
-
setId
Sets the id of the DB record- Parameters:
id-
-
getName
String getName()The name of the property as it exists in property files (for example googleAnalytics.webPropertyId)- Returns:
-
setName
Sets the property name.- Parameters:
name-
-
getOverrideGeneratedPropertyName
Boolean getOverrideGeneratedPropertyName()Declares whether or not the property name has been overridden, rather than using the default generated value.- Returns:
-
setOverrideGeneratedPropertyName
Sets the overrideGeneratedPropertyName.- Parameters:
overrideGeneratedPropertyName-
-
getValue
String getValue()Returns the property value. -
setValue
Sets the property value.- Parameters:
value-
-
getPropertyType
SystemPropertyFieldType getPropertyType()Returns the property field type. If not set, returns STRING- Returns:
-
setPropertyType
Sets the property field type.- Parameters:
type-
-
getFriendlyName
String getFriendlyName()- Returns:
- the friendly name of this property
-
setFriendlyName
Sets the friendly name of this property- Parameters:
friendlyName-
-
getFriendlyGroup
String getFriendlyGroup()- Returns:
- the griendly group name of this property
-
setFriendlyGroup
Sets the friendly group name of this property- Parameters:
friendlyGroup-
-
getFriendlyTab
String getFriendlyTab()- Returns:
- the friendly tab of this property
-
setFriendlyTab
Sets the friendly tab of this property- Parameters:
friendlyTab-
-