ContentBox Core API 1.6.0

contentbox.model.content
Class ContentStore

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

public class ContentStore
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 represent a content value store

Property Summary
Type Property & Description Default Serializable Required
 any description


Attributes:
  • notnull = false
  • length = 500
true false
 
Constructor Summary
init()
          constructor
 
Method Summary
 any GETDESCRIPTION()
          get:
 ContentStore SETDESCRIPTION(any description)
          set:
 any getMemento()
          Get a flat representation of this page
 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
 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

description

any description

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

Method Detail

GETDESCRIPTION

public any GETDESCRIPTION()
get:


SETDESCRIPTION

public ContentStore SETDESCRIPTION(any description)
set:

Parameters:
description

getMemento

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

Overrides:
getMemento in class BaseContent

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

validate

public array validate()


ContentBox Core API 1.6.0