dw.experience
Class Page
Object
dw.experience.Page
 ======================
 PAGE DESIGNER BETA API
 ======================
 
This class represents a page designer managed page. A page comprises of multiple regions that hold components, which themselves again can have regions holding components, i.e. spanning a hierarchical tree of components. Using the PageMgr.renderPage(String, String) a page can be rendered. As such page implements a view function for creating render output the view function of the page itself will also want to access its various properties like the SEO title etc.
Properties
description  :  String  (Read Only)
The description of this page.
ID  :  String  (Read Only)
The id of this page.
name  :  String  (Read Only)
The name of this page.
SEODescription  :  String  (Read Only)
The SEO description of this page.
SEOKeywords  :  String  (Read Only)
The SEO keywords of this page.
SEOTitle  :  String  (Read Only)
The SEO title of this page.
typeID  :  String  (Read Only)
The type id of this page.
visible  :  boolean  (Read Only)
Returns if the page is currently visible according to its visibility rules which means:
  • online flag is set to true
  • schedule matches
  • customer group matches

As visibility is driven by the merchant configured dynamic visibility rules, e.g. scheduling and custom segmentation, this call should NOT happen in a pagecached context outside of the processing induced by PageMgr.renderPage(String, String).

Constructor Summary
This class does not have a constructor, so you cannot create it directly.
Method Summary
getDescription() : String
Returns the description of this page.
getID() : String
Returns the id of this page.
getName() : String
Returns the name of this page.
getRegion(id : String) : Region
Returns the page region that matches the given id.
getSEODescription() : String
Returns the SEO description of this page.
getSEOKeywords() : String
Returns the SEO keywords of this page.
getSEOTitle() : String
Returns the SEO title of this page.
getTypeID() : String
Returns the type id of this page.
isVisible() : boolean
Returns if the page is currently visible according to its visibility rules which means:
  • online flag is set to true
  • schedule matches
  • customer group matches

As visibility is driven by the merchant configured dynamic visibility rules, e.g.

Methods inherited from class Object
Method Detail
getDescription
getDescription() : String
Returns the description of this page.
Returns:
the page description

getID
getID() : String
Returns the id of this page.
Returns:
the page id

getName
getName() : String
Returns the name of this page.
Returns:
the page name

getRegion
getRegion(id : String) : Region
Returns the page region that matches the given id.
Parameters:
id - the id of the desired page region
Returns:
the region, or null if not found.

getSEODescription
getSEODescription() : String
Returns the SEO description of this page.
Returns:
the page SEO description

getSEOKeywords
getSEOKeywords() : String
Returns the SEO keywords of this page.
Returns:
the page SEO keywords

getSEOTitle
getSEOTitle() : String
Returns the SEO title of this page.
Returns:
the page SEO title

getTypeID
getTypeID() : String
Returns the type id of this page.
Returns:
the page type id

isVisible
isVisible() : boolean
Returns if the page is currently visible according to its visibility rules which means:
  • online flag is set to true
  • schedule matches
  • customer group matches

As visibility is driven by the merchant configured dynamic visibility rules, e.g. scheduling and custom segmentation, this call should NOT happen in a pagecached context outside of the processing induced by PageMgr.renderPage(String, String).

Returns:
true if the page is currently visible, otherwise false