Package org.broadleafcommerce.common.enumeration.domain

Class DataDrivenEnumerationImpl

java.lang.Object

org.broadleafcommerce.common.enumeration.domain.DataDrivenEnumerationImpl

All Implemented Interfaces:

Serializable, MultiTenantCloneable<DataDrivenEnumeration>, DataDrivenEnumeration

@Entity
public class DataDrivenEnumerationImpl
extends Object
implements DataDrivenEnumeration

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected List<DataDrivenEnumerationValue>	enumValues
protected Long	id
protected String	key
protected Boolean	modifiable

Constructor Summary

Constructors

Constructor	Description
DataDrivenEnumerationImpl()

Method Summary

Modifier and Type	Method	Description
<G extends DataDrivenEnumeration> CreateResponse<G>	createOrRetrieveCopyInstance(MultiTenantCopyContext context)	Clone this entity for the purpose of multiple tenancy.
List<DataDrivenEnumerationValue>	getEnumValues()	Gets list of values associated with this enumeration with the hidden flag set to false or null.
Long	getId()
String	getKey()
Boolean	getModifiable()
List<DataDrivenEnumerationValue>	getOrderItems()	Deprecated.
void	setEnumValues(List<DataDrivenEnumerationValue> enumValues)	Sets list of values associated with this enumeration.
void	setId(Long id)
void	setKey(String key)
void	setModifiable(Boolean modifiable)
void	setOrderItems(List<DataDrivenEnumerationValue> orderItems)	Deprecated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

id

protected Long id

key

protected String key

modifiable

protected Boolean modifiable

enumValues

protected List<DataDrivenEnumerationValue> enumValues

Constructor Details

DataDrivenEnumerationImpl

public DataDrivenEnumerationImpl()

Method Details

getId

public Long getId()

Specified by:

getId in interface DataDrivenEnumeration

setId

public void setId(Long id)

Specified by:

setId in interface DataDrivenEnumeration

getKey

public String getKey()

Specified by:

getKey in interface DataDrivenEnumeration

setKey

public void setKey(String key)

Specified by:

setKey in interface DataDrivenEnumeration

getModifiable

public Boolean getModifiable()

Specified by:

getModifiable in interface DataDrivenEnumeration

setModifiable

public void setModifiable(Boolean modifiable)

Specified by:

setModifiable in interface DataDrivenEnumeration

getEnumValues

public List<DataDrivenEnumerationValue> getEnumValues()

Description copied from interface: DataDrivenEnumeration

Gets list of values associated with this enumeration with the hidden flag set to false or null.

Specified by:

getEnumValues in interface DataDrivenEnumeration

setEnumValues

public void setEnumValues(List<DataDrivenEnumerationValue> enumValues)

Description copied from interface: DataDrivenEnumeration

Sets list of values associated with this enumeration.

Specified by:

setEnumValues in interface DataDrivenEnumeration

getOrderItems

@Deprecated
public List<DataDrivenEnumerationValue> getOrderItems()

Deprecated.

Description copied from interface: DataDrivenEnumeration

Incorrectly named, kept purely for API consistency

Specified by:

getOrderItems in interface DataDrivenEnumeration

setOrderItems

@Deprecated
public void setOrderItems(List<DataDrivenEnumerationValue> orderItems)

Deprecated.

Description copied from interface: DataDrivenEnumeration

Incorrectly named, kept purely for API consistency

Specified by:

setOrderItems in interface DataDrivenEnumeration

createOrRetrieveCopyInstance

public <G extends DataDrivenEnumeration>
CreateResponse<G> createOrRetrieveCopyInstance(MultiTenantCopyContext context)
                                        throws CloneNotSupportedException

Description copied from interface: MultiTenantCloneable

Clone this entity for the purpose of multiple tenancy. Note, extending classes should follow this pattern:

public CreateResponse<MyClass> createOrRetrieveCopyInstance(MultiTenantCopyContext context) throws CloneNotSupportedException { CreateResponse<MyClass> createResponse = super.createOrRetrieveCopyInstance(context); if (createResponse.isAlreadyPopulated()) { return createResponse; } MyClass myClone = createResponse.getClone();

//copy extended field values on myClone here

return createResponse; }

Support should also be added for @Embeddable classes that contribute fields (collections or basic) to a cloneable entity:

public CreateResponse<G extends MyClass> createOrRetrieveCopyInstance(MultiTenantCopyContext context) throws CloneNotSupportedException { CreateResponse createResponse = context.createOrRetrieveCopyInstance(this); MyClass myClone = createResponse.getClone();

//copy extended field values on myClone here

return createResponse; }

Specified by:

createOrRetrieveCopyInstance in interface MultiTenantCloneable<DataDrivenEnumeration>

Parameters:

context - a context object providing persistence and library functionality for copying entities

Returns:

the resulting copy container, possibly already persisted

Throws:

CloneNotSupportedException - if there's a problem detected with the cloning configuration