Class PageImpl
java.lang.Object
org.broadleafcommerce.cms.page.domain.PageImpl
- All Implemented Interfaces:
Serializable,Page,PageAdminPresentation,AdminMainEntity,MultiTenantCloneable<Page>,ProfileEntity,Locatable
@Entity
public class PageImpl
extends Object
implements Page, AdminMainEntity, Locatable, ProfileEntity, PageAdminPresentation
Created by bpolster.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.broadleafcommerce.cms.page.domain.PageAdminPresentation
PageAdminPresentation.GroupName, PageAdminPresentation.GroupOrder, PageAdminPresentation.TabName, PageAdminPresentation.TabOrder -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected Dateprotected Dateprotected Map<String,PageAttribute> protected Stringprotected Booleanprotected Stringprotected Longprotected Stringprotected Stringprotected BooleanDeprecated.protected PageTemplateprotected IntegerDeprecated.protected Set<PageItemCriteria>Deprecated.Fields inherited from interface org.broadleafcommerce.common.admin.domain.AdminMainEntity
MAIN_ENTITY_NAME_PROPERTY -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescription<G extends Page>
CreateResponse<G>Clone this entity for the purpose of multiple tenancy.booleanReturns the excludeFromSiteMap flag.getId()If this is returning something that is non-null, this MUST return a String that starts with a slash and does not end with a slash.Returns the offlineFlag.Returns a map of the targeting rules associated with this page.Gets the integer priority of this content item.Returns the item (or cart) based rules associated with this content item.voidsetActiveEndDate(Date activeEndDate) voidsetActiveStartDate(Date activeStartDate) voidsetAdditionalAttributes(Map<String, PageAttribute> additionalAttributes) voidsetDescription(String description) voidsetExcludeFromSiteMap(boolean excludeFromSiteMap) Sets the excludeFromSiteMap flag.voidsetFullUrl(String fullUrl) voidvoidsetMetaDescription(String metaDescription) voidsetMetaTitle(String metaTitle) voidsetOfflineFlag(Boolean offlineFlag) Sets the offline flag.voidsetPageFields(Map<String, PageField> pageFields) voidsetPageMatchRules(Map<String, PageRule> pageMatchRules) Sets the targeting rules for this content item.voidsetPageTemplate(PageTemplate pageTemplate) voidsetPriority(Integer priority) Sets the display priority of this item.voidsetQualifyingItemCriteria(Set<PageItemCriteria> qualifyingItemCriteria) Sets the item (e.g. cart) based rules associated with this content item.
-
Field Details
-
id
-
pageTemplate
-
description
-
fullUrl
-
pageFields
-
priority
Deprecated. -
offlineFlag
-
pageMatchRules
Deprecated. -
qualifyingItemCriteria
Deprecated. -
excludeFromSiteMap
-
additionalAttributes
-
activeStartDate
-
activeEndDate
-
metaTitle
-
metaDescription
-
-
Constructor Details
-
PageImpl
public PageImpl()
-
-
Method Details
-
getId
-
setId
-
getPageTemplate
- Specified by:
getPageTemplatein interfacePage
-
setPageTemplate
- Specified by:
setPageTemplatein interfacePage
-
getPageFields
- Specified by:
getPageFieldsin interfacePage
-
setPageFields
- Specified by:
setPageFieldsin interfacePage
-
getFullUrl
- Specified by:
getFullUrlin interfacePage
-
setFullUrl
- Specified by:
setFullUrlin interfacePage
-
getDescription
- Specified by:
getDescriptionin interfacePage
-
setDescription
- Specified by:
setDescriptionin interfacePage
-
getOfflineFlag
Description copied from interface:PageReturns 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.- Specified by:
getOfflineFlagin interfacePage- Returns:
- true if this item is offline
-
setOfflineFlag
Description copied from interface:PageSets the offline flag.- Specified by:
setOfflineFlagin interfacePage
-
getPriority
Description copied from interface:PageGets the integer priority of this content item. Items with a lower priority should be displayed before items with a higher priority.- Specified by:
getPriorityin interfacePage- Returns:
- the priority as a numeric value
-
setPriority
Description copied from interface:PageSets the display priority of this item. Lower priorities should be displayed first.- Specified by:
setPriorityin interfacePage
-
getPageMatchRules
Description copied from interface:PageReturns 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.
- Specified by:
getPageMatchRulesin interfacePage- Returns:
-
setPageMatchRules
Description copied from interface:PageSets the targeting rules for this content item.- Specified by:
setPageMatchRulesin interfacePage
-
getQualifyingItemCriteria
Description copied from interface:PageReturns the item (or cart) based rules associated with this content item.- Specified by:
getQualifyingItemCriteriain interfacePage- Returns:
-
setQualifyingItemCriteria
Description copied from interface:PageSets the item (e.g. cart) based rules associated with this content item.- Specified by:
setQualifyingItemCriteriain interfacePage
-
getExcludeFromSiteMap
public boolean getExcludeFromSiteMap()Description copied from interface:PageReturns the excludeFromSiteMap flag. True indicates that the page should be excluded from the site map.- Specified by:
getExcludeFromSiteMapin interfacePage- Returns:
- true if this page is excluded from the site map
-
setExcludeFromSiteMap
public void setExcludeFromSiteMap(boolean excludeFromSiteMap) Description copied from interface:PageSets the excludeFromSiteMap flag.- Specified by:
setExcludeFromSiteMapin interfacePage
-
createOrRetrieveCopyInstance
public <G extends Page> CreateResponse<G> createOrRetrieveCopyInstance(MultiTenantCopyContext context) throws CloneNotSupportedException Description copied from interface:MultiTenantCloneableClone 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();Support should also be added for @Embeddable classes that contribute fields (collections or basic) to a cloneable entity://copy extended field values on myClone here
return createResponse; }
public CreateResponse<G extends MyClass> createOrRetrieveCopyInstance(MultiTenantCopyContext context) throws CloneNotSupportedException { CreateResponsecreateResponse = context.createOrRetrieveCopyInstance(this); MyClass myClone = createResponse.getClone(); //copy extended field values on myClone here
return createResponse; }
- Specified by:
createOrRetrieveCopyInstancein interfaceMultiTenantCloneable<Page>- 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
-
getMainEntityName
- Specified by:
getMainEntityNamein interfaceAdminMainEntity- Returns:
- the display name of this entity for the admin screen
-
getLocation
Description copied from interface:LocatableIf this is returning something that is non-null, this MUST return a String that starts with a slash and does not end with a slash.- Specified by:
getLocationin interfaceLocatable- Returns:
- the url of the locatable item
-
getAdditionalAttributes
- Specified by:
getAdditionalAttributesin interfacePage
-
setAdditionalAttributes
- Specified by:
setAdditionalAttributesin interfacePage
-
getActiveStartDate
- Specified by:
getActiveStartDatein interfacePage
-
setActiveStartDate
- Specified by:
setActiveStartDatein interfacePage
-
getActiveEndDate
- Specified by:
getActiveEndDatein interfacePage
-
setActiveEndDate
- Specified by:
setActiveEndDatein interfacePage
-
getMetaTitle
- Specified by:
getMetaTitlein interfacePage
-
setMetaTitle
- Specified by:
setMetaTitlein interfacePage
-
getMetaDescription
- Specified by:
getMetaDescriptionin interfacePage
-
setMetaDescription
- Specified by:
setMetaDescriptionin interfacePage
-