ContentBox Core API 1.5.7

contentbox.model.content
Class BaseContent

WEB-INF.cftags.component
        extended by contentbox.model.content.BaseContent
Direct Known Subclasses:
ContentStore , Entry , Page

public class BaseContent
extends WEB-INF.cftags.component

A mapped super class used for contentbox content: entries and pages


Method Summary
 void ADDACTIVECONTENT(ContentVersion activeContent)
 void ADDCHILD(BaseContent child)
 void ADDCOMMENT(Comment comment)
 void ADDCONTENTVERSION(ContentVersion contentVersion)
 void ADDCUSTOMFIELD(CustomField customField)
 any GETALLOWCOMMENTS()
 any GETCACHE()
 any GETCACHEBOX()
 any GETCACHELASTACCESSTIMEOUT()
 any GETCACHELAYOUT()
 any GETCACHETIMEOUT()
 array GETCATEGORIES()
 any GETCATEGORYSERVICE()
 array GETCHILDREN()
 array GETCOMMENTS()
 any GETCONTENTID()
 any GETCONTENTSERVICE()
 any GETCONTENTTYPE()
 array GETCONTENTVERSIONS()
 any GETCONTENTVERSIONSERVICE()
 any GETCREATEDDATE()
 any GETCREATOR()
 array GETCUSTOMFIELDS()
 any GETCUSTOMFIELDSERVICE()
 any GETEXPIREDATE()
 any GETHITS()
 any GETHTMLDESCRIPTION()
 any GETHTMLKEYWORDS()
 any GETINTERCEPTORSERVICE()
 any GETISPUBLISHED()
 any GETMARKUP()
 any GETNUMBEROFAPPROVEDCOMMENTS()
 any GETNUMBEROFCHILDREN()
 any GETNUMBEROFCOMMENTS()
 any GETNUMBEROFVERSIONS()
 any GETPARENT()
 any GETPASSWORDPROTECTION()
 any GETPUBLISHEDDATE()
 any GETRENDEREDCONTENT()
 any GETSETTINGSERVICE()
 any GETSLUG()
 any GETTITLE()
 boolean HASACTIVECONTENT([ContentVersion activeContent])
 boolean HASCATEGORIES([Category categories])
 boolean HASCHILD([BaseContent children])
 boolean HASCOMMENT([Comment comments])
 boolean HASCONTENTVERSION([ContentVersion contentVersions])
 boolean HASCREATOR()
 boolean HASCUSTOMFIELD([CustomField customFields])
 boolean HASPARENT()
 boolean REMOVEACTIVECONTENT(ContentVersion activeContent)
 boolean REMOVECHILD(BaseContent child)
 boolean REMOVECOMMENT(Comment comment)
 boolean REMOVECONTENTVERSION(ContentVersion contentVersion)
 boolean REMOVECUSTOMFIELD(CustomField customField)
 void SETACTIVECONTENT(array activeContent)
 void SETALLOWCOMMENTS(any allowComments)
 void SETCACHE(any cache)
 void SETCACHEBOX(any cachebox)
 void SETCACHELASTACCESSTIMEOUT(any cacheLastAccessTimeout)
 void SETCACHELAYOUT(any cacheLayout)
 void SETCACHETIMEOUT(any cacheTimeout)
 void SETCATEGORYSERVICE(any categoryService)
 void SETCONTENTSERVICE(any contentService)
 void SETCONTENTVERSIONSERVICE(any contentVersionService)
 void SETCREATEDDATE(any createdDate)
 void SETCREATOR(any creator)
 void SETCUSTOMFIELDSERVICE(any customFieldService)
 void SETEXPIREDATE(any expireDate)
 void SETHITS(any hits)
 void SETHTMLDESCRIPTION(any HTMLDescription)
 void SETHTMLKEYWORDS(any HTMLKeywords)
 void SETINTERCEPTORSERVICE(any interceptorService)
 void SETISPUBLISHED(any isPublished)
 void SETMARKUP(any markup)
 void SETNUMBEROFAPPROVEDCOMMENTS(any numberOfApprovedComments)
 void SETNUMBEROFCHILDREN(any numberOfChildren)
 void SETNUMBEROFCOMMENTS(any numberOfComments)
 void SETNUMBEROFVERSIONS(any numberOfVersions)
 void SETPARENT(any parent)
 void SETPASSWORDPROTECTION(any passwordProtection)
 void SETPUBLISHEDDATE(any publishedDate)
 void SETRENDEREDCONTENT(any renderedContent)
 void SETSETTINGSERVICE(any settingService)
 void SETSLUG(any slug)
 void SETTITLE(any title)
 BaseContent addCategories(any category)
          Bi directional add
 any addExpiredTime(any hour, any minute)
          add expired timestamp to property
 any addNewContentVersion(any content, [any changelog=''], any author)
          Add a new content version to save for this content object
 any addPublishedTime(any hour, any minute)
          add published timestamp to property
 string buildContentCacheKey()
          Build content cache keys according to sent content object
 boolean canCacheContent()
          Verify we can do content caching on this content object using global and local rules
 any getActiveContent()
 any getAuthor()
          Shorthand Author from latest version or null if any yet
 string getAuthorEmail()
          Shorthand Author email from latest version
 string getAuthorName()
          Shorthand Author name from latest version
 any getCategoriesList()
          get flat categories list
 any getContent()
 string getCreatorEmail()
          Shorthand Creator email
 string getCreatorName()
          Shorthand Creator name
 string getDisplayCreatedDate()
          Get formatted createdDate
 string getDisplayExpireDate()
          Get formatted expireDate
 string getDisplayPublishedDate()
          Get display publishedDate
 string getExpireDateForEditor([boolean showTime='false'])
          Get display expireDate
 any getMemento()
          Get a flat representation of this entry
 any getParentID()
          Get parent ID if set or empty if none
 any getParentName()
          Get parent name or empty if none
 string getPublishedDateForEditor([boolean showTime='false'])
          Get display publishedDate
 any getRecursiveSlug([any separator='/'])
          Get recursive slug paths to get ancestry, DEPRECATED
 any inflateCustomFields(numeric fieldCount, struct memento)
          Inflate custom fields from the incoming count and memento structure
 boolean isContentPublished()
          Bit that denotes if the content has been published or not
 boolean isExpired()
          Bit that denotes if the content has expired or not, in order to be expired the content must have been published as well
 boolean isLoaded()
          is loaded?
 boolean isPasswordProtected()
          isPassword Protected
 boolean isPublishedInFuture()
          Bit that denotes if the content has been published or not in the future
private any maxContentVersionChecks()
 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
 BaseContent removeAllCategories()
 BaseContent removeCategories(any category)
          Bi directional remove
 any renderContent()
          Render content out using translations, caching, etc
 any renderContentSilent([any content='[runtime expression]'])
          Renders the content silently so no caching, or extra fluff is done, just content translation rendering
 BaseContent setCategories(array categories)
          Override the setCategories
 BaseContent setChildren(array children)
          Override the setChildren
 BaseContent setComments(array comments)
          Override the setComments
 BaseContent setContentVersions(array contentVersions)
          Override the setContentVersions
 BaseContent setCustomFields(array customFields)
          Override the setCustomFields
 
Methods inherited from class WEB-INF.cftags.component
 

Method Detail

ADDACTIVECONTENT

public void ADDACTIVECONTENT(ContentVersion activeContent)

Parameters:
activeContent

ADDCHILD

public void ADDCHILD(BaseContent child)

Parameters:
child

ADDCOMMENT

public void ADDCOMMENT(Comment comment)

Parameters:
comment

ADDCONTENTVERSION

public void ADDCONTENTVERSION(ContentVersion contentVersion)

Parameters:
contentVersion

ADDCUSTOMFIELD

public void ADDCUSTOMFIELD(CustomField customField)

Parameters:
customField

GETALLOWCOMMENTS

public any GETALLOWCOMMENTS()


GETCACHE

public any GETCACHE()


GETCACHEBOX

public any GETCACHEBOX()


GETCACHELASTACCESSTIMEOUT

public any GETCACHELASTACCESSTIMEOUT()


GETCACHELAYOUT

public any GETCACHELAYOUT()


GETCACHETIMEOUT

public any GETCACHETIMEOUT()


GETCATEGORIES

public array GETCATEGORIES()


GETCATEGORYSERVICE

public any GETCATEGORYSERVICE()


GETCHILDREN

public array GETCHILDREN()


GETCOMMENTS

public array GETCOMMENTS()


GETCONTENTID

public any GETCONTENTID()


GETCONTENTSERVICE

public any GETCONTENTSERVICE()


GETCONTENTTYPE

public any GETCONTENTTYPE()


GETCONTENTVERSIONS

public array GETCONTENTVERSIONS()


GETCONTENTVERSIONSERVICE

public any GETCONTENTVERSIONSERVICE()


GETCREATEDDATE

public any GETCREATEDDATE()


GETCREATOR

public any GETCREATOR()


GETCUSTOMFIELDS

public array GETCUSTOMFIELDS()


GETCUSTOMFIELDSERVICE

public any GETCUSTOMFIELDSERVICE()


GETEXPIREDATE

public any GETEXPIREDATE()


GETHITS

public any GETHITS()


GETHTMLDESCRIPTION

public any GETHTMLDESCRIPTION()


GETHTMLKEYWORDS

public any GETHTMLKEYWORDS()


GETINTERCEPTORSERVICE

public any GETINTERCEPTORSERVICE()


GETISPUBLISHED

public any GETISPUBLISHED()


GETMARKUP

public any GETMARKUP()


GETNUMBEROFAPPROVEDCOMMENTS

public any GETNUMBEROFAPPROVEDCOMMENTS()


GETNUMBEROFCHILDREN

public any GETNUMBEROFCHILDREN()


GETNUMBEROFCOMMENTS

public any GETNUMBEROFCOMMENTS()


GETNUMBEROFVERSIONS

public any GETNUMBEROFVERSIONS()


GETPARENT

public any GETPARENT()


GETPASSWORDPROTECTION

public any GETPASSWORDPROTECTION()


GETPUBLISHEDDATE

public any GETPUBLISHEDDATE()


GETRENDEREDCONTENT

public any GETRENDEREDCONTENT()


GETSETTINGSERVICE

public any GETSETTINGSERVICE()


GETSLUG

public any GETSLUG()


GETTITLE

public any GETTITLE()


HASACTIVECONTENT

public boolean HASACTIVECONTENT([ContentVersion activeContent])

Parameters:
activeContent

HASCATEGORIES

public boolean HASCATEGORIES([Category categories])

Parameters:
categories

HASCHILD

public boolean HASCHILD([BaseContent children])

Parameters:
children

HASCOMMENT

public boolean HASCOMMENT([Comment comments])

Parameters:
comments

HASCONTENTVERSION

public boolean HASCONTENTVERSION([ContentVersion contentVersions])

Parameters:
contentVersions

HASCREATOR

public boolean HASCREATOR()


HASCUSTOMFIELD

public boolean HASCUSTOMFIELD([CustomField customFields])

Parameters:
customFields

HASPARENT

public boolean HASPARENT()


REMOVEACTIVECONTENT

public boolean REMOVEACTIVECONTENT(ContentVersion activeContent)

Parameters:
activeContent

REMOVECHILD

public boolean REMOVECHILD(BaseContent child)

Parameters:
child

REMOVECOMMENT

public boolean REMOVECOMMENT(Comment comment)

Parameters:
comment

REMOVECONTENTVERSION

public boolean REMOVECONTENTVERSION(ContentVersion contentVersion)

Parameters:
contentVersion

REMOVECUSTOMFIELD

public boolean REMOVECUSTOMFIELD(CustomField customField)

Parameters:
customField

SETACTIVECONTENT

public void SETACTIVECONTENT(array activeContent)

Parameters:
activeContent

SETALLOWCOMMENTS

public void SETALLOWCOMMENTS(any allowComments)

Parameters:
allowComments

SETCACHE

public void SETCACHE(any cache)

Parameters:
cache

SETCACHEBOX

public void SETCACHEBOX(any cachebox)

Parameters:
cachebox

SETCACHELASTACCESSTIMEOUT

public void SETCACHELASTACCESSTIMEOUT(any cacheLastAccessTimeout)

Parameters:
cacheLastAccessTimeout

SETCACHELAYOUT

public void SETCACHELAYOUT(any cacheLayout)

Parameters:
cacheLayout

SETCACHETIMEOUT

public void SETCACHETIMEOUT(any cacheTimeout)

Parameters:
cacheTimeout

SETCATEGORYSERVICE

public void SETCATEGORYSERVICE(any categoryService)

Parameters:
categoryService

SETCONTENTSERVICE

public void SETCONTENTSERVICE(any contentService)

Parameters:
contentService

SETCONTENTVERSIONSERVICE

public void SETCONTENTVERSIONSERVICE(any contentVersionService)

Parameters:
contentVersionService

SETCREATEDDATE

public void SETCREATEDDATE(any createdDate)

Parameters:
createdDate

SETCREATOR

public void SETCREATOR(any creator)

Parameters:
creator

SETCUSTOMFIELDSERVICE

public void SETCUSTOMFIELDSERVICE(any customFieldService)

Parameters:
customFieldService

SETEXPIREDATE

public void SETEXPIREDATE(any expireDate)

Parameters:
expireDate

SETHITS

public void SETHITS(any hits)

Parameters:
hits

SETHTMLDESCRIPTION

public void SETHTMLDESCRIPTION(any HTMLDescription)

Parameters:
HTMLDescription

SETHTMLKEYWORDS

public void SETHTMLKEYWORDS(any HTMLKeywords)

Parameters:
HTMLKeywords

SETINTERCEPTORSERVICE

public void SETINTERCEPTORSERVICE(any interceptorService)

Parameters:
interceptorService

SETISPUBLISHED

public void SETISPUBLISHED(any isPublished)

Parameters:
isPublished

SETMARKUP

public void SETMARKUP(any markup)

Parameters:
markup

SETNUMBEROFAPPROVEDCOMMENTS

public void SETNUMBEROFAPPROVEDCOMMENTS(any numberOfApprovedComments)

Parameters:
numberOfApprovedComments

SETNUMBEROFCHILDREN

public void SETNUMBEROFCHILDREN(any numberOfChildren)

Parameters:
numberOfChildren

SETNUMBEROFCOMMENTS

public void SETNUMBEROFCOMMENTS(any numberOfComments)

Parameters:
numberOfComments

SETNUMBEROFVERSIONS

public void SETNUMBEROFVERSIONS(any numberOfVersions)

Parameters:
numberOfVersions

SETPARENT

public void SETPARENT(any parent)

Parameters:
parent

SETPASSWORDPROTECTION

public void SETPASSWORDPROTECTION(any passwordProtection)

Parameters:
passwordProtection

SETPUBLISHEDDATE

public void SETPUBLISHEDDATE(any publishedDate)

Parameters:
publishedDate

SETRENDEREDCONTENT

public void SETRENDEREDCONTENT(any renderedContent)

Parameters:
renderedContent

SETSETTINGSERVICE

public void SETSETTINGSERVICE(any settingService)

Parameters:
settingService

SETSLUG

public void SETSLUG(any slug)

Parameters:
slug

SETTITLE

public void SETTITLE(any title)

Parameters:
title

addCategories

public BaseContent addCategories(any category)
Bi directional add

Parameters:
category

addExpiredTime

public any addExpiredTime(any hour, any minute)
add expired timestamp to property

Parameters:
hour
minute

addNewContentVersion

public any addNewContentVersion(any content, [any changelog=''], any author)
Add a new content version to save for this content object

Parameters:
content
changelog
author

addPublishedTime

public any addPublishedTime(any hour, any minute)
add published timestamp to property

Parameters:
hour
minute

buildContentCacheKey

public string buildContentCacheKey()
Build content cache keys according to sent content object


canCacheContent

public boolean canCacheContent()
Verify we can do content caching on this content object using global and local rules


getActiveContent

public any getActiveContent()


getAuthor

public any getAuthor()
Shorthand Author from latest version or null if any yet


getAuthorEmail

public string getAuthorEmail()
Shorthand Author email from latest version


getAuthorName

public string getAuthorName()
Shorthand Author name from latest version


getCategoriesList

public any getCategoriesList()
get flat categories list


getContent

public any getContent()


getCreatorEmail

public string getCreatorEmail()
Shorthand Creator email


getCreatorName

public string getCreatorName()
Shorthand Creator name


getDisplayCreatedDate

public string getDisplayCreatedDate()
Get formatted createdDate


getDisplayExpireDate

public string getDisplayExpireDate()
Get formatted expireDate


getDisplayPublishedDate

public string getDisplayPublishedDate()
Get display publishedDate


getExpireDateForEditor

public string getExpireDateForEditor([boolean showTime='false'])
Get display expireDate

Parameters:
showTime

getMemento

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


getParentID

public any getParentID()
Get parent ID if set or empty if none


getParentName

public any getParentName()
Get parent name or empty if none


getPublishedDateForEditor

public string getPublishedDateForEditor([boolean showTime='false'])
Get display publishedDate

Parameters:
showTime

getRecursiveSlug

public any getRecursiveSlug([any separator='/'])
Get recursive slug paths to get ancestry, DEPRECATED.

Parameters:
separator

inflateCustomFields

public any inflateCustomFields(numeric fieldCount, struct memento)
Inflate custom fields from the incoming count and memento structure

Parameters:
fieldCount
memento

isContentPublished

public boolean isContentPublished()
Bit that denotes if the content has been published or not


isExpired

public boolean isExpired()
Bit that denotes if the content has expired or not, in order to be expired the content must have been published as well


isLoaded

public boolean isLoaded()
is loaded?


isPasswordProtected

public boolean isPasswordProtected()
isPassword Protected


isPublishedInFuture

public boolean isPublishedInFuture()
Bit that denotes if the content has been published or not in the future


maxContentVersionChecks

private any maxContentVersionChecks()


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

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

removeAllCategories

public BaseContent removeAllCategories()


removeCategories

public BaseContent removeCategories(any category)
Bi directional remove

Parameters:
category

renderContent

public any renderContent()
Render content out using translations, caching, etc.


renderContentSilent

public any renderContentSilent([any content='[runtime expression]'])
Renders the content silently so no caching, or extra fluff is done, just content translation rendering.

Parameters:
content - The content markup to translate, by default it uses the active content version's content

setCategories

public BaseContent setCategories(array categories)
Override the setCategories

Parameters:
categories

setChildren

public BaseContent setChildren(array children)
Override the setChildren

Parameters:
children

setComments

public BaseContent setComments(array comments)
Override the setComments

Parameters:
comments

setContentVersions

public BaseContent setContentVersions(array contentVersions)
Override the setContentVersions

Parameters:
contentVersions

setCustomFields

public BaseContent setCustomFields(array customFields)
Override the setCustomFields

Parameters:
customFields

ContentBox Core API 1.5.7