org.broadleafcommerce.cms.structure.domain
Interface StructuredContent

All Superinterfaces:

Serializable

All Known Implementing Classes:

StructuredContentImpl

public interface StructuredContent
extends Serializable

StructuredContent implementations provide a representation of a generic content item with a set of predefined fields. The fields associated with an instance of StructuredContent are defined by its associated StructuredContentType.
StructuredContent items are typically maintained via the Broadleaf Commerce admin.
Display structured content items is typically done using the DisplayContentTag taglib.
An typical usage for StructuredContent is to display targeted ads. Consider a StructuredContentType of "ad" with fields "ad-image" and "target-url". This "ad" might show on a websites home page. By adding StructuredContentMatchRules and setting the priority, different ads could be shown to different users. It would not be typical in a Broadleaf implementation to extend this interface or to use any implementation other than StructuredContentImpl.

Author:

Brian Polster, Jeff Fischer

See Also:

StructuredContentType}, StructuredContentImpl}, org.broadleafcommerce.cms.web.structure.DisplayContentTag}

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.
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.

Method Detail

getId

@Nullable
Long getId()

Gets the primary key.

Returns:

the primary key

setId

void setId(@Nullable
           Long id)

Sets the primary key.

Parameters:

id - the new primary key

getContentName

@Nonnull
String getContentName()

Gets the name.

Returns:

the name

setContentName

void setContentName(@Nonnull
                    String contentName)

Sets the name.

Parameters:

contentName -

getLocale

@Nonnull
Locale getLocale()

Gets the Locale associated with this content item.

Returns:

setLocale

void setLocale(@Nonnull
               Locale locale)

Sets the locale associated with this content item.

Parameters:

locale -

getStructuredContentType

@Nonnull
StructuredContentType getStructuredContentType()

Gets the StructuredContentType associated with this content item.

Returns:

setStructuredContentType

void setStructuredContentType(@Nonnull
                              StructuredContentType structuredContentType)

Sets the StructuredContentType associated with this content item.

getStructuredContentFields

@Nullable
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. 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")

Returns:

setStructuredContentFields

void setStructuredContentFields(@Nullable
                                Map<String,StructuredContentField> structuredContentFields)

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

Parameters:

structuredContentFields -

getOfflineFlag

@Nullable
Boolean getOfflineFlag()

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.

Returns:

true if this item is offline

setOfflineFlag

void setOfflineFlag(@Nullable
                    Boolean offlineFlag)

Sets the offline flag.

Parameters:

offlineFlag -

getPriority

@Nullable
Integer getPriority()

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

Returns:

the priority as a numeric value

setPriority

void setPriority(@Nullable
                 Integer priority)

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

Parameters:

priority -

getAuditable

@Nullable
AdminAuditable getAuditable()

Returns audit information for this content item.

Returns:

setAuditable

void setAuditable(@Nullable
                  AdminAuditable auditable)

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

Parameters:

auditable -

getStructuredContentMatchRules

@Nullable
Map<String,StructuredContentRule> getStructuredContentMatchRules()

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.

Returns:

setStructuredContentMatchRules

void setStructuredContentMatchRules(@Nullable
                                    Map<String,StructuredContentRule> structuredContentMatchRules)

Sets the targeting rules for this content item.

Parameters:

structuredContentMatchRules -

getQualifyingItemCriteria

@Nullable
Set<StructuredContentItemCriteria> getQualifyingItemCriteria()

Returns the item (or cart) based rules associated with this content item.

Returns:

setQualifyingItemCriteria

void setQualifyingItemCriteria(@Nullable
                               Set<StructuredContentItemCriteria> qualifyingItemCriteria)

Sets the item (e.g. cart) based rules associated with this content item.

Parameters:

qualifyingItemCriteria -