org.broadleafcommerce.cms.page.domain

Interface Page

All Superinterfaces:

MultiTenantCloneable<Page>, Serializable

All Known Implementing Classes:

PageImpl

public interface Page
extends Serializable, MultiTenantCloneable<Page>

Created by bpolster.

Method Summary

Methods

Modifier and Type	Method and Description
Date	getActiveEndDate()
Date	getActiveStartDate()
Map<String,PageAttribute>	getAdditionalAttributes()
AdminAuditable	getAuditable()
String	getDescription()
boolean	getExcludeFromSiteMap() Returns the excludeFromSiteMap flag.
String	getFullUrl()
Long	getId()
String	getMetaDescription()
String	getMetaTitle()
Boolean	getOfflineFlag() Returns the offlineFlag.
Map<String,PageField>	getPageFields()
Map<String,PageRule>	getPageMatchRules() Returns a map of the targeting rules associated with this page.
PageTemplate	getPageTemplate()
Integer	getPriority() Gets the integer priority of this content item.
Set<PageItemCriteria>	getQualifyingItemCriteria() Returns the item (or cart) based rules associated with this content item.
void	setActiveEndDate(Date activeEndDate)
void	setActiveStartDate(Date activeStartDate)
void	setAdditionalAttributes(Map<String,PageAttribute> additionalAttributes)
void	setAuditable(AdminAuditable auditable)
void	setDescription(String description)
void	setExcludeFromSiteMap(boolean excludeFromSiteMap) Sets the excludeFromSiteMap flag.
void	setFullUrl(String fullUrl)
void	setId(Long id)
void	setMetaDescription(String metaDescription)
void	setMetaTitle(String metaTitle)
void	setOfflineFlag(Boolean offlineFlag) Sets the offline flag.
void	setPageFields(Map<String,PageField> pageFields)
void	setPageMatchRules(Map<String,PageRule> pageRules) Sets the targeting rules for this content item.
void	setPageTemplate(PageTemplate pageTemplate)
void	setPriority(Integer priority) Sets the display priority of this item.
void	setQualifyingItemCriteria(Set<PageItemCriteria> qualifyingItemCriteria) Sets the item (e.g.

Methods inherited from interface org.broadleafcommerce.common.copy.MultiTenantCloneable

createOrRetrieveCopyInstance

Method Detail

getId

Long getId()

setId

void setId(Long id)

getFullUrl

String getFullUrl()

setFullUrl

void setFullUrl(String fullUrl)

getDescription

String getDescription()

setDescription

void setDescription(String description)

getPageTemplate

PageTemplate getPageTemplate()

setPageTemplate

void setPageTemplate(PageTemplate pageTemplate)

getPageFields

Map<String,PageField> getPageFields()

setPageFields

void setPageFields(Map<String,PageField> pageFields)

getAuditable

AdminAuditable getAuditable()

setAuditable

void setAuditable(AdminAuditable auditable)

getOfflineFlag

@Nullable
Boolean getOfflineFlag()

Returns the offlineFlag. True indicates that the page 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 -

getPageMatchRules

@Nullable
Map<String,PageRule> getPageMatchRules()

Returns a map of the targeting rules associated with this page. Targeting rules are defined in the content mangagement system and used to enforce which page is returned to the client.

Returns:

setPageMatchRules

void setPageMatchRules(@Nullable
                     Map<String,PageRule> pageRules)

Sets the targeting rules for this content item.

Parameters:

pageRules -

getQualifyingItemCriteria

@Nullable
Set<PageItemCriteria> getQualifyingItemCriteria()

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

Returns:

setQualifyingItemCriteria

void setQualifyingItemCriteria(@Nullable
                             Set<PageItemCriteria> qualifyingItemCriteria)

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

Parameters:

qualifyingItemCriteria -

getExcludeFromSiteMap

@Nullable
boolean getExcludeFromSiteMap()

Returns the excludeFromSiteMap flag. True indicates that the page should be excluded from the site map.

Returns:

true if this page is excluded from the site map

setExcludeFromSiteMap

void setExcludeFromSiteMap(boolean excludeFromSiteMap)

Sets the excludeFromSiteMap flag.

Parameters:

excludeFromSiteMap -

getAdditionalAttributes

Map<String,PageAttribute> getAdditionalAttributes()

setAdditionalAttributes

void setAdditionalAttributes(Map<String,PageAttribute> additionalAttributes)

getActiveStartDate

Date getActiveStartDate()

setActiveStartDate

void setActiveStartDate(Date activeStartDate)

getActiveEndDate

Date getActiveEndDate()

setActiveEndDate

void setActiveEndDate(Date activeEndDate)

getMetaTitle

String getMetaTitle()

setMetaTitle

void setMetaTitle(String metaTitle)

getMetaDescription

String getMetaDescription()

setMetaDescription

void setMetaDescription(String metaDescription)