org.broadleafcommerce.common.config.domain

Interface SystemProperty

All Superinterfaces:

MultiTenantCloneable<SystemProperty>, Serializable

All Known Implementing Classes:

NullSystemProperty, SystemPropertyImpl

public interface SystemProperty
extends Serializable, MultiTenantCloneable<SystemProperty>

This interface represents a System Property (name/value pair) stored in the database.

User: Kelly Tisdell Date: 6/20/12

Method Summary

Modifier and Type	Method and Description
String	getFriendlyGroup()
String	getFriendlyName()
String	getFriendlyTab()
Long	getId() Unique id of the DB record
String	getName() The name of the property as it exists in property files (for example googleAnalytics.webPropertyId)
Boolean	getOverrideGeneratedPropertyName() Declares whether or not the property name has been overridden, rather than using the default generated value.
SystemPropertyFieldType	getPropertyType() Returns the property field type.
String	getValue() Returns the property value.
void	setFriendlyGroup(String friendlyGroup) Sets the friendly group name of this property
void	setFriendlyName(String friendlyName) Sets the friendly name of this property
void	setFriendlyTab(String friendlyTab) Sets the friendly tab of this property
void	setId(Long id) Sets the id of the DB record
void	setName(String name) Sets the property name.
void	setOverrideGeneratedPropertyName(Boolean overrideGeneratedPropertyName) Sets the overrideGeneratedPropertyName.
void	setPropertyType(SystemPropertyFieldType type) Sets the property field type.
void	setValue(String value) Sets the property value.

Methods inherited from interface org.broadleafcommerce.common.copy.MultiTenantCloneable

createOrRetrieveCopyInstance

Method Detail

getId

Long getId()

Unique id of the DB record

Returns:

setId

void setId(Long id)

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

void setName(String name)

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

void setOverrideGeneratedPropertyName(Boolean overrideGeneratedPropertyName)

Sets the overrideGeneratedPropertyName.

Parameters:

overrideGeneratedPropertyName -

getValue

String getValue()

Returns the property value.

Parameters:

name -

setValue

void setValue(String value)

Sets the property value.

Parameters:

name -

getPropertyType

SystemPropertyFieldType getPropertyType()

Returns the property field type. If not set, returns STRING

Returns:

setPropertyType

void setPropertyType(SystemPropertyFieldType type)

Sets the property field type.

Parameters:

type -

getFriendlyName

String getFriendlyName()

Returns:

the friendly name of this property

setFriendlyName

void setFriendlyName(String friendlyName)

Sets the friendly name of this property

Parameters:

friendlyName -

getFriendlyGroup

String getFriendlyGroup()

Returns:

the griendly group name of this property

setFriendlyGroup

void setFriendlyGroup(String friendlyGroup)

Sets the friendly group name of this property

Parameters:

friendlyGroup -

getFriendlyTab

String getFriendlyTab()

Returns:

the friendly tab of this property

setFriendlyTab

void setFriendlyTab(String friendlyTab)

Sets the friendly tab of this property

Parameters:

friendlyTab -