com.elasticpath.domain.attribute
Interface Attribute

All Superinterfaces:

java.lang.Comparable, Entity, EpDomain, Persistence, java.io.Serializable

All Known Implementing Classes:

AttributeImpl

public interface Attribute
extends Entity, java.lang.Comparable

An Attribute reprents a customized property of an object like Category or Product.

Method Summary

AttributeType	getAttributeType() Return the AttributeType of this attribute.
AttributeUsage	getAttributeUsage() Return the AttributeUsage of this attribute.
java.lang.String	getKey() Get the attribute key.
java.lang.String	getName() Get the product system name.
boolean	isIncludedInSearchIndex() Return true if the attribute should be included in the search index.
boolean	isLocaleDependant() Return true if the attribute is dependant on the locale.
boolean	isMultiValueEnabled() Return true if the attribute can have multi value.
boolean	isRequired() Return true if the attribute is required.
boolean	isSystem() Return true if the attribute is system attribute.
boolean	isUsedInGuidedNavigation() Return true if this attribute is used in guided navigation.
boolean	isValueLookupEnabled() Return true if the value lookup for this attribute is enabled.
void	setAttributeType(AttributeType attributeType) Set the AttributeType of this attribute.
void	setAttributeUsage(AttributeUsage attributeUsage) Set the AttributeUsage of this attribute.
void	setIncludedInSearchIndex(boolean includedInSearchIndex) Set the included in search index flag.
void	setKey(java.lang.String key) Set the attribute key.
void	setLocaleDependant(boolean localeDependant) Set the locale-dependant flag.
void	setMultiValueEnabled(boolean multiValueEnabled) Set the attribute can have multi value.
void	setName(java.lang.String name) Set the product system name.
void	setRequired(boolean required) Set the required flag.
void	setSystem(boolean system) Set the system flag.
void	setUsedInGuidedNavigation(boolean usedInGuidedNavigation) Set this attribute is used in guided navigation.
void	setValueLookupEnabled(boolean valueLookupEnabled) Sets whether or not the user will have the option of selecting from previously existing values when editing an attribute.

Methods inherited from interface com.elasticpath.domain.Entity

getGuid, setGuid

Methods inherited from interface com.elasticpath.domain.Persistence

executeBeforePersistAction, getUidPk, isPersistent, setDefaultValues, setUidPk

Methods inherited from interface com.elasticpath.domain.EpDomain

getElasticPath, setElasticPath

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getAttributeType

AttributeType getAttributeType()

Return the AttributeType of this attribute.

Returns:

the AttributeType of this attribute

getAttributeUsage

AttributeUsage getAttributeUsage()

Return the AttributeUsage of this attribute.

Returns:

the AttributeUsage of this attribute

getKey

java.lang.String getKey()

Get the attribute key.

Returns:

the attribute key

getName

java.lang.String getName()

Get the product system name.

Returns:

the product system name

isIncludedInSearchIndex

boolean isIncludedInSearchIndex()

Return true if the attribute should be included in the search index.

Returns:

true if the attribute should be included in the search index

isLocaleDependant

boolean isLocaleDependant()

Return true if the attribute is dependant on the locale.

Returns:

true if the attribute is dependant on the locale

isMultiValueEnabled

boolean isMultiValueEnabled()

Return true if the attribute can have multi value.

Returns:

true if the attribute can have multi value.

isRequired

boolean isRequired()

Return true if the attribute is required.

Returns:

true if the attribute is required

isSystem

boolean isSystem()

Return true if the attribute is system attribute.

Returns:

true if the attribute is system attribute

isUsedInGuidedNavigation

boolean isUsedInGuidedNavigation()

Return true if this attribute is used in guided navigation.

Returns:

true if this attribute is used in guided navigation.

isValueLookupEnabled

boolean isValueLookupEnabled()

Return true if the value lookup for this attribute is enabled. If value-lookup is enabled, users have the option of selecting from existing previously existing attribute values when setting the attribute's value.

Returns:

true if the value lookup for this attribute is enabled.

setAttributeType

void setAttributeType(AttributeType attributeType)

Set the AttributeType of this attribute.

Parameters:

attributeType - the attribute type.

setAttributeUsage

void setAttributeUsage(AttributeUsage attributeUsage)

Set the AttributeUsage of this attribute.

Parameters:

attributeUsage - the attribute usage

setIncludedInSearchIndex

void setIncludedInSearchIndex(boolean includedInSearchIndex)

Set the included in search index flag.

Parameters:

includedInSearchIndex - the included in search index flag

setKey

void setKey(java.lang.String key)

Set the attribute key.

Parameters:

key - the key to set

setLocaleDependant

void setLocaleDependant(boolean localeDependant)

Set the locale-dependant flag.

Parameters:

localeDependant - the locale-dependant flag.

setMultiValueEnabled

void setMultiValueEnabled(boolean multiValueEnabled)

Set the attribute can have multi value.

Parameters:

multiValueEnabled - the multiValueEnabled to set

setName

void setName(java.lang.String name)

Set the product system name.

Parameters:

name - the product system name

setRequired

void setRequired(boolean required)

Set the required flag.

Parameters:

required - the required flag

setSystem

void setSystem(boolean system)

Set the system flag.

Parameters:

system - the system flag

setUsedInGuidedNavigation

void setUsedInGuidedNavigation(boolean usedInGuidedNavigation)

Set this attribute is used in guided navigation.

Parameters:

usedInGuidedNavigation - the usedInGuidedNavigation to set

setValueLookupEnabled

void setValueLookupEnabled(boolean valueLookupEnabled)

Sets whether or not the user will have the option of selecting from previously existing values when editing an attribute.

Parameters:

valueLookupEnabled - set to true if lookup is to be enabled.