ContentBox Core API 1.6.0

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

Property Summary
Type Property & Description Default Serializable Required
 any HTMLDescription


Attributes:
  • notnull = false
  • length = 160
true false
 any HTMLKeywords


Attributes:
  • notnull = false
  • length = 160
true false
 array activeContent


Attributes:
  • inverse = true
  • where = isActive=1
  • lazy = extra
  • fieldtype = one-to-many
  • cascade = save-update
  • cfc = contentbox.model.content.ContentVersion
  • fkcolumn = FK_contentID
true false
 any allowComments


Attributes:
  • ormtype = boolean
  • notnull = true
  • dbdefault = 1
true true false
 any cache


Attributes:
  • index = idx_cache
  • ormtype = boolean
  • notnull = true
  • dbdefault = 1
true true false
 any cacheLastAccessTimeout


Attributes:
  • index = idx_cachelastaccesstimeout
  • ormtype = integer
  • notnull = false
  • dbdefault = 0
0 true false
 any cacheLayout


Attributes:
  • index = idx_cachelayout
  • ormtype = boolean
  • notnull = true
  • dbdefault = 1
true true false
 any cacheTimeout


Attributes:
  • index = idx_cachetimeout
  • ormtype = integer
  • notnull = false
  • dbdefault = 0
0 true false
 any cachebox


Attributes:
  • inject = cachebox
  • persistent = false
true false
 array categories


Attributes:
  • inverse = true
  • lazy = extra
  • linktable = cb_contentCategories
  • fieldtype = many-to-many
  • orderby = category
  • inversejoincolumn = FK_categoryID
  • cascade = all
  • cfc = contentbox.model.content.Category
  • fkcolumn = FK_contentID
true false
 any categoryService


Attributes:
  • inject = categoryService@cb
  • persistent = false
true false
 array children


Attributes:
  • inverse = true
  • lazy = extra
  • batchsize = 25
  • fieldtype = one-to-many
  • singularname = child
  • orderby = createdDate
  • cascade = all-delete-orphan
  • cfc = contentbox.model.content.BaseContent
  • fkcolumn = FK_parentID
true false
 array comments


Attributes:
  • inverse = true
  • lazy = extra
  • batchsize = 25
  • fieldtype = one-to-many
  • singularname = comment
  • orderby = createdDate
  • cascade = all-delete-orphan
  • cfc = contentbox.model.comments.Comment
  • fkcolumn = FK_contentID
true false
 any contentID


Attributes:
  • generator = native
  • fieldtype = id
  • notnull = true
  • setter = false
true false
 any contentService


Attributes:
  • inject = contentService@cb
  • persistent = false
true false
 any contentType


Attributes:
  • update = false
  • index = idx_discriminator,idx_published
  • insert = false
  • dbdefault =
  • setter = false
true false
 any contentVersionService


Attributes:
  • inject = contentVersionService@cb
  • persistent = false
true false
 array contentVersions


Attributes:
  • inverse = true
  • lazy = extra
  • batchsize = 25
  • fieldtype = one-to-many
  • singularname = contentVersion
  • cascade = all-delete-orphan
  • cfc = contentbox.model.content.ContentVersion
  • fkcolumn = FK_contentID
true false
 any createdDate


Attributes:
  • update = false
  • index = idx_createdDate
  • ormtype = timestamp
  • notnull = true
true false
 any creator


Attributes:
  • fieldtype = many-to-one
  • fetch = join
  • notnull = true
  • lazy = true
  • cfc = contentbox.model.security.Author
  • fkcolumn = FK_authorID
true false
 any customFieldService


Attributes:
  • inject = customFieldService@cb
  • persistent = false
true false
 array customFields


Attributes:
  • inverse = true
  • lazy = extra
  • batchsize = 25
  • fieldtype = one-to-many
  • singularname = customField
  • cascade = all-delete-orphan
  • cfc = contentbox.model.content.CustomField
  • fkcolumn = FK_contentID
true false
 any expireDate


Attributes:
  • index = idx_expireDate
  • ormtype = timestamp
  • notnull = false
true false
 any hits


Attributes:
  • ormtype = long
  • notnull = false
  • dbdefault = 0
0 true false
 any interceptorService


Attributes:
  • inject = coldbox:interceptorService
  • persistent = false
true false
 any isPublished


Attributes:
  • index = idx_published,idx_search,idx_publishedSlug
  • ormtype = boolean
  • notnull = true
  • dbdefault = 1
true true false
 any markup


Attributes:
  • notnull = true
  • dbdefault = 'HTML'
  • length = 100
html true false
 any numberOfApprovedComments


Attributes:
  • formula = select count(*) from cb_comment comment where comment.FK_contentID=contentID and comment.isApproved = 1
0 true false
 any numberOfChildren


Attributes:
  • formula = select count(*) from cb_content content where content.FK_parentID=contentID
0 true false
 any numberOfComments


Attributes:
  • formula = select count(*) from cb_comment comment where comment.FK_contentID=contentID
0 true false
 any numberOfVersions


Attributes:
  • formula = select count(*) from cb_contentVersion cv where cv.FK_contentID=contentID
0 true false
 any parent


Attributes:
  • fieldtype = many-to-one
  • lazy = true
  • cfc = contentbox.model.content.BaseContent
  • fkcolumn = FK_parentID
true false
 any passwordProtection


Attributes:
  • index = idx_published
  • notnull = false
  • length = 100
true false
 any publishedDate


Attributes:
  • index = idx_publishedDate
  • ormtype = timestamp
  • notnull = false
true false
 any renderedContent


Attributes:
  • persistent = false
true false
 any settingService


Attributes:
  • inject = id:settingService@cb
  • persistent = false
true false
 any slug


Attributes:
  • index = idx_slug,idx_publishedSlug
  • unique = true
  • notnull = true
  • length = 200
true false
 any title


Attributes:
  • index = idx_search
  • notnull = true
  • length = 200
true false
 
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)
 BaseContent SETACTIVECONTENT(array activeContent)
 BaseContent SETALLOWCOMMENTS(any allowComments)
 BaseContent SETCACHE(any cache)
 BaseContent SETCACHEBOX(any cachebox)
 BaseContent SETCACHELASTACCESSTIMEOUT(any cacheLastAccessTimeout)
 BaseContent SETCACHELAYOUT(any cacheLayout)
 BaseContent SETCACHETIMEOUT(any cacheTimeout)
 BaseContent SETCATEGORYSERVICE(any categoryService)
 BaseContent SETCONTENTSERVICE(any contentService)
 BaseContent SETCONTENTVERSIONSERVICE(any contentVersionService)
 BaseContent SETCREATEDDATE(any createdDate)
 BaseContent SETCREATOR(any creator)
 BaseContent SETCUSTOMFIELDSERVICE(any customFieldService)
 BaseContent SETEXPIREDATE(any expireDate)
 BaseContent SETHITS(any hits)
 BaseContent SETHTMLDESCRIPTION(any HTMLDescription)
 BaseContent SETHTMLKEYWORDS(any HTMLKeywords)
 BaseContent SETINTERCEPTORSERVICE(any interceptorService)
 BaseContent SETISPUBLISHED(any isPublished)
 BaseContent SETMARKUP(any markup)
 BaseContent SETNUMBEROFAPPROVEDCOMMENTS(any numberOfApprovedComments)
 BaseContent SETNUMBEROFCHILDREN(any numberOfChildren)
 BaseContent SETNUMBEROFCOMMENTS(any numberOfComments)
 BaseContent SETNUMBEROFVERSIONS(any numberOfVersions)
 BaseContent SETPARENT(any parent)
 BaseContent SETPASSWORDPROTECTION(any passwordProtection)
 BaseContent SETPUBLISHEDDATE(any publishedDate)
 BaseContent SETRENDEREDCONTENT(any renderedContent)
 BaseContent SETSETTINGSERVICE(any settingService)
 BaseContent SETSLUG(any slug)
 BaseContent 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
 struct getCustomFieldsAsStruct()
          Get custom fields as a structure representation
 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
None
 

Property Detail

HTMLDescription

any HTMLDescription

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

HTMLKeywords

any HTMLKeywords

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

activeContent

array activeContent

Attributes:
inverse - true
where - isActive=1
serializable - true
lazy - extra
default -
fieldtype - one-to-many
required - false
cascade - save-update
cfc - contentbox.model.content.ContentVersion
fkcolumn - FK_contentID

allowComments

any allowComments

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

cache

any cache

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

cacheLastAccessTimeout

any cacheLastAccessTimeout

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

cacheLayout

any cacheLayout

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

cacheTimeout

any cacheTimeout

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

cachebox

any cachebox

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

categories

array categories

Attributes:
inverse - true
serializable - true
lazy - extra
default -
linktable - cb_contentCategories
fieldtype - many-to-many
orderby - category
required - false
inversejoincolumn - FK_categoryID
cascade - all
cfc - contentbox.model.content.Category
fkcolumn - FK_contentID

categoryService

any categoryService

Attributes:
inject - categoryService@cb
serializable - true
required - false
persistent - false
default -

children

array children

Attributes:
inverse - true
serializable - true
lazy - extra
batchsize - 25
default -
fieldtype - one-to-many
singularname - child
orderby - createdDate
required - false
cascade - all-delete-orphan
cfc - contentbox.model.content.BaseContent
fkcolumn - FK_parentID

comments

array comments

Attributes:
inverse - true
serializable - true
lazy - extra
batchsize - 25
default -
fieldtype - one-to-many
singularname - comment
orderby - createdDate
required - false
cascade - all-delete-orphan
cfc - contentbox.model.comments.Comment
fkcolumn - FK_contentID

contentID

any contentID

Attributes:
generator - native
fieldtype - id
serializable - true
required - false
notnull - true
default -
setter - false

contentService

any contentService

Attributes:
inject - contentService@cb
serializable - true
required - false
persistent - false
default -

contentType

any contentType

Attributes:
update - false
index - idx_discriminator,idx_published
insert - false
serializable - true
required - false
dbdefault -
setter - false
default -

contentVersionService

any contentVersionService

Attributes:
inject - contentVersionService@cb
serializable - true
required - false
persistent - false
default -

contentVersions

array contentVersions

Attributes:
inverse - true
serializable - true
lazy - extra
batchsize - 25
default -
fieldtype - one-to-many
singularname - contentVersion
required - false
cascade - all-delete-orphan
cfc - contentbox.model.content.ContentVersion
fkcolumn - FK_contentID

createdDate

any createdDate

Attributes:
update - false
index - idx_createdDate
ormtype - timestamp
serializable - true
required - false
notnull - true
default -

creator

any creator

Attributes:
fieldtype - many-to-one
fetch - join
serializable - true
required - false
notnull - true
lazy - true
cfc - contentbox.model.security.Author
default -
fkcolumn - FK_authorID

customFieldService

any customFieldService

Attributes:
inject - customFieldService@cb
serializable - true
required - false
persistent - false
default -

customFields

array customFields

Attributes:
inverse - true
serializable - true
lazy - extra
batchsize - 25
default -
fieldtype - one-to-many
singularname - customField
required - false
cascade - all-delete-orphan
cfc - contentbox.model.content.CustomField
fkcolumn - FK_contentID

expireDate

any expireDate

Attributes:
index - idx_expireDate
ormtype - timestamp
serializable - true
required - false
notnull - false
default -

hits

any hits

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

interceptorService

any interceptorService

Attributes:
inject - coldbox:interceptorService
serializable - true
required - false
persistent - false
default -

isPublished

any isPublished

Attributes:
index - idx_published,idx_search,idx_publishedSlug
ormtype - boolean
serializable - true
required - false
notnull - true
dbdefault - 1
default - true

markup

any markup

Attributes:
serializable - true
required - false
notnull - true
dbdefault - 'HTML'
length - 100
default - html

numberOfApprovedComments

any numberOfApprovedComments

Attributes:
formula - select count(*) from cb_comment comment where comment.FK_contentID=contentID and comment.isApproved = 1
required - false
serializable - true
default - 0

numberOfChildren

any numberOfChildren

Attributes:
formula - select count(*) from cb_content content where content.FK_parentID=contentID
required - false
serializable - true
default - 0

numberOfComments

any numberOfComments

Attributes:
formula - select count(*) from cb_comment comment where comment.FK_contentID=contentID
required - false
serializable - true
default - 0

numberOfVersions

any numberOfVersions

Attributes:
formula - select count(*) from cb_contentVersion cv where cv.FK_contentID=contentID
required - false
serializable - true
default - 0

parent

any parent

Attributes:
fieldtype - many-to-one
serializable - true
required - false
lazy - true
cfc - contentbox.model.content.BaseContent
default -
fkcolumn - FK_parentID

passwordProtection

any passwordProtection

Attributes:
index - idx_published
serializable - true
required - false
notnull - false
length - 100
default -

publishedDate

any publishedDate

Attributes:
index - idx_publishedDate
ormtype - timestamp
serializable - true
required - false
notnull - false
default -

renderedContent

any renderedContent

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

settingService

any settingService

Attributes:
inject - id:settingService@cb
serializable - true
required - false
persistent - false
default -

slug

any slug

Attributes:
index - idx_slug,idx_publishedSlug
unique - true
serializable - true
required - false
notnull - true
length - 200
default -

title

any title

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

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 BaseContent SETACTIVECONTENT(array activeContent)

Parameters:
activeContent

SETALLOWCOMMENTS

public BaseContent SETALLOWCOMMENTS(any allowComments)

Parameters:
allowComments

SETCACHE

public BaseContent SETCACHE(any cache)

Parameters:
cache

SETCACHEBOX

public BaseContent SETCACHEBOX(any cachebox)

Parameters:
cachebox

SETCACHELASTACCESSTIMEOUT

public BaseContent SETCACHELASTACCESSTIMEOUT(any cacheLastAccessTimeout)

Parameters:
cacheLastAccessTimeout

SETCACHELAYOUT

public BaseContent SETCACHELAYOUT(any cacheLayout)

Parameters:
cacheLayout

SETCACHETIMEOUT

public BaseContent SETCACHETIMEOUT(any cacheTimeout)

Parameters:
cacheTimeout

SETCATEGORYSERVICE

public BaseContent SETCATEGORYSERVICE(any categoryService)

Parameters:
categoryService

SETCONTENTSERVICE

public BaseContent SETCONTENTSERVICE(any contentService)

Parameters:
contentService

SETCONTENTVERSIONSERVICE

public BaseContent SETCONTENTVERSIONSERVICE(any contentVersionService)

Parameters:
contentVersionService

SETCREATEDDATE

public BaseContent SETCREATEDDATE(any createdDate)

Parameters:
createdDate

SETCREATOR

public BaseContent SETCREATOR(any creator)

Parameters:
creator

SETCUSTOMFIELDSERVICE

public BaseContent SETCUSTOMFIELDSERVICE(any customFieldService)

Parameters:
customFieldService

SETEXPIREDATE

public BaseContent SETEXPIREDATE(any expireDate)

Parameters:
expireDate

SETHITS

public BaseContent SETHITS(any hits)

Parameters:
hits

SETHTMLDESCRIPTION

public BaseContent SETHTMLDESCRIPTION(any HTMLDescription)

Parameters:
HTMLDescription

SETHTMLKEYWORDS

public BaseContent SETHTMLKEYWORDS(any HTMLKeywords)

Parameters:
HTMLKeywords

SETINTERCEPTORSERVICE

public BaseContent SETINTERCEPTORSERVICE(any interceptorService)

Parameters:
interceptorService

SETISPUBLISHED

public BaseContent SETISPUBLISHED(any isPublished)

Parameters:
isPublished

SETMARKUP

public BaseContent SETMARKUP(any markup)

Parameters:
markup

SETNUMBEROFAPPROVEDCOMMENTS

public BaseContent SETNUMBEROFAPPROVEDCOMMENTS(any numberOfApprovedComments)

Parameters:
numberOfApprovedComments

SETNUMBEROFCHILDREN

public BaseContent SETNUMBEROFCHILDREN(any numberOfChildren)

Parameters:
numberOfChildren

SETNUMBEROFCOMMENTS

public BaseContent SETNUMBEROFCOMMENTS(any numberOfComments)

Parameters:
numberOfComments

SETNUMBEROFVERSIONS

public BaseContent SETNUMBEROFVERSIONS(any numberOfVersions)

Parameters:
numberOfVersions

SETPARENT

public BaseContent SETPARENT(any parent)

Parameters:
parent

SETPASSWORDPROTECTION

public BaseContent SETPASSWORDPROTECTION(any passwordProtection)

Parameters:
passwordProtection

SETPUBLISHEDDATE

public BaseContent SETPUBLISHEDDATE(any publishedDate)

Parameters:
publishedDate

SETRENDEREDCONTENT

public BaseContent SETRENDEREDCONTENT(any renderedContent)

Parameters:
renderedContent

SETSETTINGSERVICE

public BaseContent SETSETTINGSERVICE(any settingService)

Parameters:
settingService

SETSLUG

public BaseContent SETSLUG(any slug)

Parameters:
slug

SETTITLE

public BaseContent 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


getCustomFieldsAsStruct

public struct getCustomFieldsAsStruct()
Get custom fields as a structure representation


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.6.0