org.broadleafcommerce.cms.structure.domain
Class StructuredContentImpl

java.lang.Object
  extended by org.broadleafcommerce.cms.structure.domain.StructuredContentImpl
All Implemented Interfaces:
Serializable, StructuredContent, AdminMainEntity

@Entity
public class StructuredContentImpl
extends Object
implements StructuredContent, AdminMainEntity

Created by bpolster.

See Also:
Serialized Form

Nested Class Summary
static class StructuredContentImpl.Presentation
           
 
Field Summary
protected  AdminAuditable auditable
           
protected  String contentName
           
protected  Long id
           
protected  Locale locale
           
protected  Boolean offlineFlag
           
protected  Integer priority
           
protected  Set<StructuredContentItemCriteria> qualifyingItemCriteria
           
protected  Map<String,StructuredContentField> structuredContentFields
           
protected  StructuredContentType structuredContentType
           
 
Fields inherited from interface org.broadleafcommerce.common.admin.domain.AdminMainEntity
MAIN_ENTITY_NAME_PROPERTY
 
Constructor Summary
StructuredContentImpl()
           
 
Method Summary
 AdminAuditable getAuditable()
          Returns audit information for this content item.
 String getContentName()
          Gets the name.
 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()
          Returns the item (or cart) based rules associated with this content item.
 Map<String,StructuredContentField> getStructuredContentFields()
          Gets a map with the custom fields associated with this content item.
The map keys are based on the field types.
 Map<String,StructuredContentRule> getStructuredContentMatchRules()
          Returns a map of the targeting rules associated with this content item.
 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 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)
          Sets the item (e.g.
 void setStructuredContentFields(Map<String,StructuredContentField> structuredContentFields)
          Sets the structured content fields for this item.
 void setStructuredContentMatchRules(Map<String,StructuredContentRule> structuredContentMatchRules)
          Sets the targeting rules for this content item.
 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,StructuredContentField> structuredContentFields

offlineFlag

protected Boolean offlineFlag
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

public Map<String,StructuredContentField> getStructuredContentFields()
Description copied from interface: StructuredContent
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:
getStructuredContentFields in interface StructuredContent
Returns:

setStructuredContentFields

public void setStructuredContentFields(Map<String,StructuredContentField> structuredContentFields)
Description copied from interface: StructuredContent
Sets the structured content fields for this item. Would not typically called outside of the ContentManagementSystem.

Specified by:
setStructuredContentFields in interface StructuredContent

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()
Description copied from interface: StructuredContent
Returns a map of the targeting rules associated with this content item. Targeting rules are defined in the content mangagement system and used to enforce which items are returned to the client.

Specified by:
getStructuredContentMatchRules in interface StructuredContent
Returns:

setStructuredContentMatchRules

public void setStructuredContentMatchRules(Map<String,StructuredContentRule> structuredContentMatchRules)
Description copied from interface: StructuredContent
Sets the targeting rules for this content item.

Specified by:
setStructuredContentMatchRules in interface StructuredContent

getQualifyingItemCriteria

public Set<StructuredContentItemCriteria> getQualifyingItemCriteria()
Description copied from interface: StructuredContent
Returns the item (or cart) based rules associated with this content item.

Specified by:
getQualifyingItemCriteria in interface StructuredContent
Returns:

setQualifyingItemCriteria

public void setQualifyingItemCriteria(Set<StructuredContentItemCriteria> qualifyingItemCriteria)
Description copied from interface: StructuredContent
Sets the item (e.g. cart) based rules associated with this content item.

Specified by:
setQualifyingItemCriteria in interface StructuredContent

getMainEntityName

public String getMainEntityName()
Specified by:
getMainEntityName in interface AdminMainEntity


Copyright © 2013. All Rights Reserved.