org.broadleafcommerce.cms.structure.domain

Class StructuredContentImpl

java.lang.Object

org.broadleafcommerce.cms.structure.domain.StructuredContentImpl

All Implemented Interfaces:

Serializable, StructuredContent, AdminMainEntity, MultiTenantCloneable<StructuredContent>, ProfileEntity

@Entity
public class StructuredContentImpl
extends Object
implements StructuredContent, AdminMainEntity, ProfileEntity

Created by bpolster.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StructuredContentImpl.Presentation

Field Summary

Fields

Modifier and Type	Field and Description
protected AdminAuditable	auditable
protected String	contentName
protected Map<String,String>	fieldValuesMap
protected Long	id
protected Map<String,StructuredContentField>	legacyStructuredContentFields
protected Locale	locale
protected Boolean	offlineFlag
protected Integer	priority
protected Set<StructuredContentItemCriteria>	qualifyingItemCriteria
protected Map<String,StructuredContentFieldXref>	structuredContentFields
protected StructuredContentType	structuredContentType

Fields inherited from interface org.broadleafcommerce.common.admin.domain.AdminMainEntity

MAIN_ENTITY_NAME_PROPERTY

Constructor Summary

Constructors

Constructor and Description
StructuredContentImpl()

Method Summary

Methods

Modifier and Type	Method and Description
<G extends StructuredContent> CreateResponse<G>	createOrRetrieveCopyInstance(MultiTenantCopyContext context) Clone this entity for the purpose of multiple tenancy.
AdminAuditable	getAuditable() Returns audit information for this content item.
String	getContentName() Gets the name.
String	getFieldValue(String fieldName) Returns the value of the associated StructuredContentField if the given fieldName exists in the map returned by StructuredContent.getStructuredContentFieldXrefs(), and null otherwise.
Map<String,String>	getFieldValues()
Long	getId() Gets the primary key.
Locale	getLocale() Gets the Locale associated with this content item.
String	getMainEntityName()
Boolean	getOfflineFlag() Returns the offlineFlag.
Integer	getPriority() Gets the integer priority of this content item.
Set<StructuredContentItemCriteria>	getQualifyingItemCriteria()
Map<String,StructuredContentField>	getStructuredContentFields() Deprecated.
Map<String,StructuredContentFieldXref>	getStructuredContentFieldXrefs() NOTE: This method is typically only used when wanting to persist new StructuredContentFields.
Map<String,StructuredContentRule>	getStructuredContentMatchRules()
StructuredContentType	getStructuredContentType() Gets the StructuredContentType associated with this content item.
void	setAuditable(AdminAuditable auditable) Sets audit information for this content item.
void	setContentName(String contentName) Sets the name.
void	setFieldValues(Map<String,String> fieldValuesMap) Sets the transient fieldValues map on this StructuredContent.
void	setId(Long id) Sets the primary key.
void	setLocale(Locale locale) Sets the locale associated with this content item.
void	setOfflineFlag(Boolean offlineFlag) Sets the offline flag.
void	setPriority(Integer priority) Sets the display priority of this item.
void	setQualifyingItemCriteria(Set<StructuredContentItemCriteria> qualifyingItemCriteria)
void	setStructuredContentFields(Map<String,StructuredContentField> structuredContentFields)
void	setStructuredContentFieldXrefs(Map<String,StructuredContentFieldXref> structuredContentFields) Sets the structured content fields for this item.
void	setStructuredContentMatchRules(Map<String,StructuredContentRule> structuredContentMatchRules)
void	setStructuredContentType(StructuredContentType structuredContentType) Sets the StructuredContentType associated with this content item.

Methods inherited from class java.lang.Object

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

Field Detail

id

protected Long id

auditable

protected AdminAuditable auditable

contentName

protected String contentName

locale

protected Locale locale

priority

protected Integer priority

qualifyingItemCriteria

protected Set<StructuredContentItemCriteria> qualifyingItemCriteria

structuredContentType

protected StructuredContentType structuredContentType

structuredContentFields

protected Map<String,StructuredContentFieldXref> structuredContentFields

legacyStructuredContentFields

protected Map<String,StructuredContentField> legacyStructuredContentFields

offlineFlag

protected Boolean offlineFlag

fieldValuesMap

protected Map<String,String> fieldValuesMap

Constructor Detail

StructuredContentImpl

public StructuredContentImpl()

Method Detail

getId

public Long getId()

Description copied from interface: StructuredContent

Gets the primary key.

Specified by:

getId in interface StructuredContent

Returns:

the primary key

setId

public void setId(Long id)

Description copied from interface: StructuredContent

Sets the primary key.

Specified by:

setId in interface StructuredContent

Parameters:

id - the new primary key

getContentName

public String getContentName()

Description copied from interface: StructuredContent

Gets the name.

Specified by:

getContentName in interface StructuredContent

Returns:

the name

setContentName

public void setContentName(String contentName)

Description copied from interface: StructuredContent

Sets the name.

Specified by:

setContentName in interface StructuredContent

getLocale

public Locale getLocale()

Description copied from interface: StructuredContent

Gets the Locale associated with this content item.

Specified by:

getLocale in interface StructuredContent

Returns:

setLocale

public void setLocale(Locale locale)

Description copied from interface: StructuredContent

Sets the locale associated with this content item.

Specified by:

setLocale in interface StructuredContent

getStructuredContentType

public StructuredContentType getStructuredContentType()

Description copied from interface: StructuredContent

Gets the StructuredContentType associated with this content item.

Specified by:

getStructuredContentType in interface StructuredContent

Returns:

setStructuredContentType

public void setStructuredContentType(StructuredContentType structuredContentType)

Description copied from interface: StructuredContent

Sets the StructuredContentType associated with this content item.

Specified by:

setStructuredContentType in interface StructuredContent

getStructuredContentFields

@Deprecated
public Map<String,StructuredContentField> getStructuredContentFields()

Deprecated.

Specified by:

getStructuredContentFields in interface StructuredContent

Returns:

setStructuredContentFields

public void setStructuredContentFields(Map<String,StructuredContentField> structuredContentFields)

Specified by:

setStructuredContentFields in interface StructuredContent

getStructuredContentFieldXrefs

public Map<String,StructuredContentFieldXref> getStructuredContentFieldXrefs()

Description copied from interface: StructuredContent

NOTE: This method is typically only used when wanting to persist new StructuredContentFields. Users trying to get a field to render should typically invoke StructuredContent.getFieldValues(). Gets a map with the custom fields associated with this content item.
The map keys are based on the field types. For example, consider a content item with a StructuredContentType of ad which defined a field named targetUrl. The field could be accessed with structuredContentItem.getStructuredContentFields().get("targetUrl")

Specified by:

getStructuredContentFieldXrefs in interface StructuredContent

Returns:

setStructuredContentFieldXrefs

public void setStructuredContentFieldXrefs(@Nullable
                                  Map<String,StructuredContentFieldXref> structuredContentFields)

Description copied from interface: StructuredContent

Sets the structured content fields for this item. Would not typically be called outside of the ContentManagementSystem.

Specified by:

setStructuredContentFieldXrefs in interface StructuredContent

getFieldValue

public String getFieldValue(String fieldName)

Description copied from interface: StructuredContent

Returns the value of the associated StructuredContentField if the given fieldName exists in the map returned by StructuredContent.getStructuredContentFieldXrefs(), and null otherwise.

Specified by:

getFieldValue in interface StructuredContent

Returns:

the value of the given field

setFieldValues

public void setFieldValues(Map<String,String> fieldValuesMap)

Description copied from interface: StructuredContent

Sets the transient fieldValues map on this StructuredContent.

Specified by:

setFieldValues in interface StructuredContent

getFieldValues

public Map<String,String> getFieldValues()

Specified by:

getFieldValues in interface StructuredContent

Returns:

a map of StructuredContentField field key names to their associated values

getOfflineFlag

public Boolean getOfflineFlag()

Description copied from interface: StructuredContent

Returns the offlineFlag. Indicates that the item should no longer appear on the site. The item will still appear within the content administration program but no longer be returned as part of the client facing APIs.

Specified by:

getOfflineFlag in interface StructuredContent

Returns:

true if this item is offline

setOfflineFlag

public void setOfflineFlag(Boolean offlineFlag)

Description copied from interface: StructuredContent

Sets the offline flag.

Specified by:

setOfflineFlag in interface StructuredContent

getPriority

public Integer getPriority()

Description copied from interface: StructuredContent

Gets the integer priority of this content item. Items with a lower priority should be displayed before items with a higher priority.

Specified by:

getPriority in interface StructuredContent

Returns:

the priority as a numeric value

setPriority

public void setPriority(Integer priority)

Description copied from interface: StructuredContent

Sets the display priority of this item. Lower priorities should be displayed first.

Specified by:

setPriority in interface StructuredContent

getAuditable

public AdminAuditable getAuditable()

Description copied from interface: StructuredContent

Returns audit information for this content item.

Specified by:

getAuditable in interface StructuredContent

Returns:

setAuditable

public void setAuditable(AdminAuditable auditable)

Description copied from interface: StructuredContent

Sets audit information for this content item. Default implementations automatically populate this data during persistence.

Specified by:

setAuditable in interface StructuredContent

getStructuredContentMatchRules

public Map<String,StructuredContentRule> getStructuredContentMatchRules()

Specified by:

getStructuredContentMatchRules in interface StructuredContent

Returns:

setStructuredContentMatchRules

public void setStructuredContentMatchRules(Map<String,StructuredContentRule> structuredContentMatchRules)

Specified by:

setStructuredContentMatchRules in interface StructuredContent

getQualifyingItemCriteria

public Set<StructuredContentItemCriteria> getQualifyingItemCriteria()

Specified by:

getQualifyingItemCriteria in interface StructuredContent

Returns:

setQualifyingItemCriteria

public void setQualifyingItemCriteria(Set<StructuredContentItemCriteria> qualifyingItemCriteria)

Specified by:

setQualifyingItemCriteria in interface StructuredContent

getMainEntityName

public String getMainEntityName()

Specified by:

getMainEntityName in interface AdminMainEntity

Returns:

the display name of this entity for the admin screen

createOrRetrieveCopyInstance

public <G extends StructuredContent> 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<StructuredContent>

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