ContentBox Core API 1.6.0

contentbox.model.content
Class Entry

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

public class Entry
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 blog entry entity that is amazing

Property Summary
Type Property & Description Default Serializable Required
 any excerpt


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


Attributes:
  • persistent = false
true false
 
Constructor Summary
init()
          constructor
 
Method Summary
 any GETEXCERPT()
          get:
 any GETRENDEREDEXCERPT()
          get:
 Entry SETEXCERPT(any excerpt)
          set:
 Entry SETRENDEREDEXCERPT(any renderedExcerpt)
          set:
 any getMemento()
          Get a flat representation of this entry
 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 -

renderedExcerpt

any renderedExcerpt

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

Method Detail

GETEXCERPT

public any GETEXCERPT()
get:


GETRENDEREDEXCERPT

public any GETRENDEREDEXCERPT()
get:


SETEXCERPT

public Entry SETEXCERPT(any excerpt)
set:

Parameters:
excerpt

SETRENDEREDEXCERPT

public Entry SETRENDEREDEXCERPT(any renderedExcerpt)
set:

Parameters:
renderedExcerpt

getMemento

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

Overrides:
getMemento in class BaseContent

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