ContentBox Core API 1.6.0

contentbox.model.content
Class Page

WEB-INF.cftags.component
        extended by contentbox.model.content.BaseContent
            extended by contentbox.model.content.Page

public class Page
extends BaseContent

******************************************************************************* ContentBox - A Modular Content Platform Copyright 2012 by Luis Majano and Ortus Solutions, Corp www.gocontentbox.org | www.luismajano.com | www.ortussolutions.com ******************************************************************************* Apache License, Version 2.0 Copyright Since [2012] [Luis Majano and Ortus Solutions,Corp] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ******************************************************************************* I am a cms page entity that totally rocks

Property Summary
Type Property & Description Default Serializable Required
 any excerpt


Attributes:
  • ormtype = text
  • notnull = false
  • length = 8000
true false
 any layout


Attributes:
  • notnull = false
  • length = 200
true false
 any mobileLayout


Attributes:
  • notnull = false
  • length = 200
true false
 any order


Attributes:
  • ormtype = integer
  • notnull = false
  • dbdefault = 0
0 true false
 any renderedExcerpt


Attributes:
  • persistent = false
true false
 any showInMenu


Attributes:
  • index = idx_showInMenu
  • ormtype = boolean
  • notnull = true
  • dbdefault = 1
true true false
 
Constructor Summary
init()
          constructor
 
Method Summary
 any GETEXCERPT()
          get:
 any GETLAYOUT()
          get:
 any GETMOBILELAYOUT()
          get:
 any GETORDER()
          get:
 any GETRENDEREDEXCERPT()
          get:
 any GETSHOWINMENU()
          get:
 Page SETEXCERPT(any excerpt)
          set:
 Page SETLAYOUT(any layout)
          set:
 Page SETMOBILELAYOUT(any mobileLayout)
          set:
 Page SETORDER(any order)
          set:
 Page SETRENDEREDEXCERPT(any renderedExcerpt)
          set:
 Page SETSHOWINMENU(any showInMenu)
          set:
 any getLayoutWithDefault()
          Get the layout or if empty the default convention of "pages"
 any getLayoutWithInheritance()
          Get layout with layout inheritance, if none found return normal saved layout
 any getMemento()
          Get a flat representation of this page
 any getMobileLayoutWithInheritance()
          Get mobile layout with layout inheritance, if none found return normal saved layout
 boolean hasExcerpt()
          has excerpt
 BaseContent prepareForClone(any author, any original, any originalService, boolean publish, any originalSlugRoot, any newSlugRoot)
          Wipe primary key, and descendant keys, and prepare for cloning of entire hierarchies
 any renderExcerpt()
          Render excerpt
 array validate()
 
Methods inherited from class contentbox.model.content.BaseContent
ADDACTIVECONTENT, ADDCHILD, ADDCOMMENT, ADDCONTENTVERSION, ADDCUSTOMFIELD, GETALLOWCOMMENTS, GETCACHE, GETCACHEBOX, GETCACHELASTACCESSTIMEOUT, GETCACHELAYOUT, GETCACHETIMEOUT, GETCATEGORIES, GETCATEGORYSERVICE, GETCHILDREN, GETCOMMENTS, GETCONTENTID, GETCONTENTSERVICE, GETCONTENTTYPE, GETCONTENTVERSIONS, GETCONTENTVERSIONSERVICE, GETCREATEDDATE, GETCREATOR, GETCUSTOMFIELDS, GETCUSTOMFIELDSERVICE, GETEXPIREDATE, GETHITS, GETHTMLDESCRIPTION, GETHTMLKEYWORDS, GETINTERCEPTORSERVICE, GETISPUBLISHED, GETMARKUP, GETNUMBEROFAPPROVEDCOMMENTS, GETNUMBEROFCHILDREN, GETNUMBEROFCOMMENTS, GETNUMBEROFVERSIONS, GETPARENT, GETPASSWORDPROTECTION, GETPUBLISHEDDATE, GETRENDEREDCONTENT, GETSETTINGSERVICE, GETSLUG, GETTITLE, HASACTIVECONTENT, HASCATEGORIES, HASCHILD, HASCOMMENT, HASCONTENTVERSION, HASCREATOR, HASCUSTOMFIELD, HASPARENT, REMOVEACTIVECONTENT, REMOVECHILD, REMOVECOMMENT, REMOVECONTENTVERSION, REMOVECUSTOMFIELD, SETACTIVECONTENT, SETALLOWCOMMENTS, SETCACHE, SETCACHEBOX, SETCACHELASTACCESSTIMEOUT, SETCACHELAYOUT, SETCACHETIMEOUT, SETCATEGORYSERVICE, SETCONTENTSERVICE, SETCONTENTVERSIONSERVICE, SETCREATEDDATE, SETCREATOR, SETCUSTOMFIELDSERVICE, SETEXPIREDATE, SETHITS, SETHTMLDESCRIPTION, SETHTMLKEYWORDS, SETINTERCEPTORSERVICE, SETISPUBLISHED, SETMARKUP, SETNUMBEROFAPPROVEDCOMMENTS, SETNUMBEROFCHILDREN, SETNUMBEROFCOMMENTS, SETNUMBEROFVERSIONS, SETPARENT, SETPASSWORDPROTECTION, SETPUBLISHEDDATE, SETRENDEREDCONTENT, SETSETTINGSERVICE, SETSLUG, SETTITLE, addCategories, addExpiredTime, addNewContentVersion, addPublishedTime, buildContentCacheKey, canCacheContent, getActiveContent, getAuthor, getAuthorEmail, getAuthorName, getCategoriesList, getContent, getCreatorEmail, getCreatorName, getCustomFieldsAsStruct, getDisplayCreatedDate, getDisplayExpireDate, getDisplayPublishedDate, getExpireDateForEditor, getParentID, getParentName, getPublishedDateForEditor, getRecursiveSlug, inflateCustomFields, isContentPublished, isExpired, isLoaded, isPasswordProtected, isPublishedInFuture, maxContentVersionChecks, removeAllCategories, removeCategories, renderContent, renderContentSilent, setCategories, setChildren, setComments, setContentVersions, setCustomFields
 
Methods inherited from class WEB-INF.cftags.component
None
 

Constructor Detail

init

public init()
constructor

Property Detail

excerpt

any excerpt

Attributes:
ormtype - text
serializable - true
required - false
notnull - false
length - 8000
default -

layout

any layout

Attributes:
serializable - true
required - false
notnull - false
length - 200
default -

mobileLayout

any mobileLayout

Attributes:
serializable - true
required - false
notnull - false
length - 200
default -

order

any order

Attributes:
ormtype - integer
serializable - true
required - false
notnull - false
dbdefault - 0
default - 0

renderedExcerpt

any renderedExcerpt

Attributes:
required - false
serializable - true
persistent - false
default -

showInMenu

any showInMenu

Attributes:
index - idx_showInMenu
ormtype - boolean
serializable - true
required - false
notnull - true
dbdefault - 1
default - true

Method Detail

GETEXCERPT

public any GETEXCERPT()
get:


GETLAYOUT

public any GETLAYOUT()
get:


GETMOBILELAYOUT

public any GETMOBILELAYOUT()
get:


GETORDER

public any GETORDER()
get:


GETRENDEREDEXCERPT

public any GETRENDEREDEXCERPT()
get:


GETSHOWINMENU

public any GETSHOWINMENU()
get:


SETEXCERPT

public Page SETEXCERPT(any excerpt)
set:

Parameters:
excerpt

SETLAYOUT

public Page SETLAYOUT(any layout)
set:

Parameters:
layout

SETMOBILELAYOUT

public Page SETMOBILELAYOUT(any mobileLayout)
set:

Parameters:
mobileLayout

SETORDER

public Page SETORDER(any order)
set:

Parameters:
order

SETRENDEREDEXCERPT

public Page SETRENDEREDEXCERPT(any renderedExcerpt)
set:

Parameters:
renderedExcerpt

SETSHOWINMENU

public Page SETSHOWINMENU(any showInMenu)
set:

Parameters:
showInMenu

getLayoutWithDefault

public any getLayoutWithDefault()
Get the layout or if empty the default convention of "pages"


getLayoutWithInheritance

public any getLayoutWithInheritance()
Get layout with layout inheritance, if none found return normal saved layout


getMemento

public any getMemento()
Get a flat representation of this page

Overrides:
getMemento in class BaseContent

getMobileLayoutWithInheritance

public any getMobileLayoutWithInheritance()
Get mobile layout with layout inheritance, if none found return normal saved layout


hasExcerpt

public boolean hasExcerpt()
has excerpt


prepareForClone

public BaseContent prepareForClone(any author, any original, any originalService, boolean publish, any originalSlugRoot, any newSlugRoot)
Wipe primary key, and descendant keys, and prepare for cloning of entire hierarchies

Overrides:
prepareForClone in class BaseContent
Parameters:
author - The author doing the cloning
original - The original content object that will be cloned into this content object
originalService - The ContentBox content service object
publish - Publish pages or leave as drafts
originalSlugRoot - The original slug that will be replaced in all cloned content
newSlugRoot - The new slug root that will be replaced in all cloned content

renderExcerpt

public any renderExcerpt()
Render excerpt


validate

public array validate()


ContentBox Core API 1.6.0