org.broadleafcommerce.cms.page.domain

Interface Page

All Superinterfaces:

Serializable

All Known Implementing Classes:

PageImpl

public interface Page
extends Serializable

Created by bpolster.

Method Summary

Methods

Modifier and Type	Method and Description
Page	cloneEntity()
Boolean	getArchivedFlag()
AdminAuditable	getAuditable()
Boolean	getDeletedFlag()
String	getDescription()
String	getFullUrl()
Long	getId()
Boolean	getLockedFlag()
Boolean	getOfflineFlag() Returns the offlineFlag.
Long	getOriginalPageId()
SandBox	getOriginalSandBox()
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.
SandBox	getSandbox()
void	setArchivedFlag(Boolean archivedFlag)
void	setAuditable(AdminAuditable auditable)
void	setDeletedFlag(Boolean deletedFlag)
void	setDescription(String description)
void	setFullUrl(String fullUrl)
void	setId(Long id)
void	setLockedFlag(Boolean lockedFlag)
void	setOfflineFlag(Boolean offlineFlag) Sets the offline flag.
void	setOriginalPageId(Long originalPageId)
void	setOriginalSandBox(SandBox originalSandBox)
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.
void	setSandbox(SandBox sandbox)

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)

getDeletedFlag

Boolean getDeletedFlag()

setDeletedFlag

void setDeletedFlag(Boolean deletedFlag)

getArchivedFlag

Boolean getArchivedFlag()

setArchivedFlag

void setArchivedFlag(Boolean archivedFlag)

getSandbox

SandBox getSandbox()

setSandbox

void setSandbox(SandBox sandbox)

getLockedFlag

Boolean getLockedFlag()

setLockedFlag

void setLockedFlag(Boolean lockedFlag)

getOriginalPageId

Long getOriginalPageId()

setOriginalPageId

void setOriginalPageId(Long originalPageId)

getOriginalSandBox

SandBox getOriginalSandBox()

setOriginalSandBox

void setOriginalSandBox(SandBox originalSandBox)

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 -

cloneEntity

Page cloneEntity()