Start page
Start page

Start page / Template development / Template syntax / Data types / Section

Section data type

Methods on Section objects

The table below lists all methods which can be invoked on objects of data type Section .

Method name Return type Brief description Available since
addToPackage(Package) void
asRevisionProvider ElementProvider
changeDate Date The change date of the object 4.0.0
clearCachedData void
compareTo(Comparable) int
compareTo(Object) int
contrastWith(IDProvider) Set
delete void
depth int Depth of the object relative to the root node (which has depth 0) 4.0.0
equals(Object) boolean
excludeFromOutput(Language) void
exportStoreElement(OutputStream, ExportHandler) void
getChangeState int
getChildCount int
getChildIndex(StoreElement) int
getChildren Listable Children of the object
getChildren(Class) Listable
getChildren(Filter$TypedFilter, boolean) Listable
getChildren(Class, boolean) Listable
getClass Class Class of the invoking object
getClientUrl(ClientUrlAgent$ClientType) String get the client url for the specified element and the current language 5.0.10
getColor Color
getCreateWorkflowPermission(Workflow) WorkflowPermission
getDefinedPrincipalPermissions List
getDisplayName(Language) String
getEditor User Last user of the object
getElementType String
getFirstChild StoreElement
getFormData FormData
getHistory List
getHistory(Date, Date, int, Filter) List
getId long ID of the object
getInRevision(Revision) IDProvider
getIncomingReferences ReferenceEntry[]
getInheritedPrincipalPermissions List
getJavaClientUrl String get the java client url for the specified element and the current language 5.0.10
getLanguageInfo(Language) LanguageInfo
getLastChanged long
getLifespan long[]
getLongID Long
getMetaFormData FormData
getName String
getNextSibling StoreElement
getOutgoingReferences ReferenceEntry[]
getPackage Package
getPackageName String
getParent StoreElement
getPermission Permission
getPermission(Group) Permission
getPermission(User) Permission
getProject Project
getReferenceName String
getReferences Set
getReleaseRevision Revision
getReleaseStatus int
getReleasedBy User
getRevision Revision
getStore Store
getTask Task
getTemplate SectionTemplate
getTreePermission PermissionMap
getUid String Reference name/UID of an object
getUidType IDProvider$UidType
getWebeditUrl String get the webedit url for the specified element and the current language 5.0.10
getWorkflowPermission(Workflow) WorkflowPermission
getWorkflowPermissions WorkflowPermission[]
getWriteLock boolean
hasIncomingReferences boolean
hasMeta boolean
hasPermissions boolean
hasTask boolean
hasUid boolean
id Long 4.0.0
importStoreElement(ZipFile, ImportHandler) StoreElement
importStoreElements(ZipFile, ImportHandler) Listable
includeInOutput(Language) void
inheritWorkflowPermission boolean
isAddable(Package) boolean
isCase(Object) boolean
isChangeable boolean
isDeleted boolean
isExportSupported boolean
isFolder boolean
isImportSupported boolean
isInLifespan boolean
isInLifespan(long) boolean
isInOutputIncluded(Language) boolean
isInReleaseStore boolean
isLockSupported boolean
isLocked boolean
isLockedOnServer(boolean) boolean
isNull boolean Checks whether an expression is null (zero)
isPackageItem boolean
isPermissionSupported boolean
isReference boolean
isReleaseSupported boolean
isReleased boolean
isSubscribedItem boolean
isWorkflowAllowed(Workflow, User) boolean
isWorkflowSupported boolean
meta(String) Object get a meta value by name 4.0
meta(String, String) Object get a meta value by name in mode 'inherit', 'add', or 'none' 4.0
moveChild(IDProvider) void
moveChild(IDProvider, int) void
print void 4.0.0
refresh void
release void
release(boolean) void
removeAllWorkflowPermissions void
removeChild(StoreElement) void
removeFromPackage(Package) void
removeLifespan void
removePermission(Group) void
removePermission(User) void
removePermission(User[]) void
removeTask void
removeWorkflowPermission(Workflow) void
replaceChild(StoreElement, StoreElement) void
revert(Revision, boolean, EnumSet) void
save void
save(String) void
save(String, boolean) void
set(String, Object) Object
setChangeState(int) void
setColor(Color) void
setDisplayName(Language, String) void
setFormData(FormData) void
setInheritWorkflowPermission(boolean) void
setLifespan(long, long) void
setLock(boolean) void
setLock(boolean, boolean) void
setMetaFormData(FormData) void
setName(String) void
setPermission(Group, Permission) void
setPermission(User, Permission) void
setPermission(User[], Permission) void
setTask(Task) void
setTemplate(SectionTemplate) void
setUid(String) void
setWorkflowPermission(WorkflowPermission) void
setWorkflowPermissions(WorkflowPermission[]) void
setWriteLock(boolean) void
toJson String Convert to JSON string representtion (only handles Maps, Collections, Arrays, Numbers, and Strings) 4.2.14
toString String
toXml String
toXml(boolean) String
toXml(boolean, boolean) String
type String

addToPackage(Package)

Method name Return type Available since
addToPackage(Package) void

asRevisionProvider

Method name Return type Available since
asRevisionProvider ElementProvider

changeDate

The method changeDate returns the change date of the object.

It is often used in combination with the system object #global. Using this system object the change date of a special object can be identified:

Method name Return type Available since
changeDate Date 4.0.0

clearCachedData

Method name Return type Available since
clearCachedData void

compareTo(Comparable)

Method name Return type Available since
compareTo(Comparable) int

compareTo(Object)

Method name Return type Available since
compareTo(Object) int

contrastWith(IDProvider)

Method name Return type Available since
contrastWith(IDProvider) Set

delete

Method name Return type Available since
delete void

depth

The method depth returns the depth of object relative to the root node. The counting begins with 0 for the root node.

The method depth is often used in combination with the system object #global.

Method name Return type Available since
depth int 4.0.0

equals(Object)

Method name Return type Available since
equals(Object) boolean

excludeFromOutput(Language)

Method name Return type Available since
excludeFromOutput(Language) void

exportStoreElement(OutputStream, ExportHandler)

Method name Return type Available since
exportStoreElement(OutputStream, ExportHandler) void

getChangeState

Method name Return type Available since
getChangeState int

getChildCount

Method name Return type Available since
getChildCount int

getChildIndex(StoreElement)

Method name Return type Available since
getChildIndex(StoreElement) int

getChildren

The method getChildren returns the direct children of the object.

Method name Return type Available since
getChildren Listable

getChildren(Class)

Method name Return type Available since
getChildren(Class) Listable

getChildren(Filter$TypedFilter, boolean)

Method name Return type Available since
getChildren(Filter$TypedFilter, boolean) Listable

getChildren(Class, boolean)

Method name Return type Available since
getChildren(Class, boolean) Listable

getClass

The .getClass() (in Bean syntax: .class) method returns the class of the invoking object (cf. java.lang.Class).

Invocation:

$CMS_VALUE(myString.class)$
$CMS_VALUE(myString.getClass())$

Output:

java.lang.String
Method name Return type Available since
getClass Class

getClientUrl(ClientUrlAgent$ClientType)

get the client url for the specified element and the current language
Method name Return type Available since
getClientUrl(ClientUrlAgent$ClientType) String 5.0.10

getColor

Method name Return type Available since
getColor Color

getCreateWorkflowPermission(Workflow)

Method name Return type Available since
getCreateWorkflowPermission(Workflow) WorkflowPermission

getDefinedPrincipalPermissions

Method name Return type Available since
getDefinedPrincipalPermissions List

getDisplayName(Language)

Method name Return type Available since
getDisplayName(Language) String

getEditor

The method getEditor returns the last user of the object.

It is often used in combination with the system object #global. Using this system object the last editor of a special object can be identified:

Method name Return type Available since
getEditor User

getElementType

Method name Return type Available since
getElementType String

getFirstChild

Method name Return type Available since
getFirstChild StoreElement

getFormData

Method name Return type Available since
getFormData FormData

getHistory

Method name Return type Available since
getHistory List

getHistory(Date, Date, int, Filter)

Method name Return type Available since
getHistory(Date, Date, int, Filter) List

getId

The method getId returns the unique ID of the object.

It is used often in combination with the system object #global. Using this system object the individual unique ID of a special object can be identified:

Method name Return type Available since
getId long

getInRevision(Revision)

Method name Return type Available since
getInRevision(Revision) IDProvider

getIncomingReferences

Method name Return type Available since
getIncomingReferences ReferenceEntry[]

getInheritedPrincipalPermissions

Method name Return type Available since
getInheritedPrincipalPermissions List

getJavaClientUrl

get the java client url for the specified element and the current language
Method name Return type Available since
getJavaClientUrl String 5.0.10

getLanguageInfo(Language)

Method name Return type Available since
getLanguageInfo(Language) LanguageInfo

getLastChanged

Method name Return type Available since
getLastChanged long

getLifespan

Method name Return type Available since
getLifespan long[]

getLongID

Method name Return type Available since
getLongID Long

getMetaFormData

Method name Return type Available since
getMetaFormData FormData

getName

Method name Return type Available since
getName String

getNextSibling

Method name Return type Available since
getNextSibling StoreElement

getOutgoingReferences

Method name Return type Available since
getOutgoingReferences ReferenceEntry[]

getPackage

Method name Return type Available since
getPackage Package

getPackageName

Method name Return type Available since
getPackageName String

getParent

Method name Return type Available since
getParent StoreElement

getPermission

Method name Return type Available since
getPermission Permission

getPermission(Group)

Method name Return type Available since
getPermission(Group) Permission

getPermission(User)

Method name Return type Available since
getPermission(User) Permission

getProject

Method name Return type Available since
getProject Project

getReferenceName

Method name Return type Available since
getReferenceName String

getReferences

Method name Return type Available since
getReferences Set

getReleaseRevision

Method name Return type Available since
getReleaseRevision Revision

getReleaseStatus

Method name Return type Available since
getReleaseStatus int

getReleasedBy

Method name Return type Available since
getReleasedBy User

getRevision

Method name Return type Available since
getRevision Revision

getStore

Method name Return type Available since
getStore Store

getTask

Method name Return type Available since
getTask Task

getTemplate

Method name Return type Available since
getTemplate SectionTemplate

getTreePermission

Method name Return type Available since
getTreePermission PermissionMap

getUid

The method getUid returns the reference name/UID ("Unified Identifier") of an object.

Method name Return type Available since
getUid String

getUidType

Method name Return type Available since
getUidType IDProvider$UidType

getWebeditUrl

get the webedit url for the specified element and the current language
Method name Return type Available since
getWebeditUrl String 5.0.10

getWorkflowPermission(Workflow)

Method name Return type Available since
getWorkflowPermission(Workflow) WorkflowPermission

getWorkflowPermissions

Method name Return type Available since
getWorkflowPermissions WorkflowPermission[]

getWriteLock

Method name Return type Available since
getWriteLock boolean

hasIncomingReferences

Method name Return type Available since
hasIncomingReferences boolean

hasMeta

Method name Return type Available since
hasMeta boolean

hasPermissions

Method name Return type Available since
hasPermissions boolean

hasTask

Method name Return type Available since
hasTask boolean

hasUid

Method name Return type Available since
hasUid boolean

id

Method name Return type Available since
id Long 4.0.0

importStoreElement(ZipFile, ImportHandler)

Method name Return type Available since
importStoreElement(ZipFile, ImportHandler) StoreElement

importStoreElements(ZipFile, ImportHandler)

Method name Return type Available since
importStoreElements(ZipFile, ImportHandler) Listable

includeInOutput(Language)

Method name Return type Available since
includeInOutput(Language) void

inheritWorkflowPermission

Method name Return type Available since
inheritWorkflowPermission boolean

isAddable(Package)

Method name Return type Available since
isAddable(Package) boolean

isCase(Object)

Method name Return type Available since
isCase(Object) boolean

isChangeable

Method name Return type Available since
isChangeable boolean

isDeleted

Method name Return type Available since
isDeleted boolean

isExportSupported

Method name Return type Available since
isExportSupported boolean

isFolder

Method name Return type Available since
isFolder boolean

isImportSupported

Method name Return type Available since
isImportSupported boolean

isInLifespan

Method name Return type Available since
isInLifespan boolean

isInLifespan(long)

Method name Return type Available since
isInLifespan(long) boolean

isInOutputIncluded(Language)

Method name Return type Available since
isInOutputIncluded(Language) boolean

isInReleaseStore

Method name Return type Available since
isInReleaseStore boolean

isLockSupported

Method name Return type Available since
isLockSupported boolean

isLocked

Method name Return type Available since
isLocked boolean

isLockedOnServer(boolean)

Method name Return type Available since
isLockedOnServer(boolean) boolean

isNull

The .isNull() (in Bean syntax: .isNull) method checks whether an expression or object is null , e.g. storeElement.isNull(). In the case of objects with complex values or objects, the object decides when it is null. The data type DomElement for example always contains an empty document, thus it is never null. For this reason, checking an empty DOM editor input component by using the method .isNull() returns the value false, whereas checking the component with .isEmpty() would return the value true.

The method .isNull() returns a Boolean value as the check result. true is the check result if the expression or object is null and false if not.

Method name Return type Available since
isNull boolean

isPackageItem

Method name Return type Available since
isPackageItem boolean

isPermissionSupported

Method name Return type Available since
isPermissionSupported boolean

isReference

Method name Return type Available since
isReference boolean

isReleaseSupported

Method name Return type Available since
isReleaseSupported boolean

isReleased

Method name Return type Available since
isReleased boolean

isSubscribedItem

Method name Return type Available since
isSubscribedItem boolean

isWorkflowAllowed(Workflow, User)

Method name Return type Available since
isWorkflowAllowed(Workflow, User) boolean

isWorkflowSupported

Method name Return type Available since
isWorkflowSupported boolean

meta(String)

get a meta value by name
Method name Return type Available since
meta(String) Object 4.0

meta(String, String)

get a meta value by name in mode 'inherit', 'add', or 'none'
Method name Return type Available since
meta(String, String) Object 4.0

moveChild(IDProvider)

Method name Return type Available since
moveChild(IDProvider) void

moveChild(IDProvider, int)

Method name Return type Available since
moveChild(IDProvider, int) void

print

Method name Return type Available since
print void 4.0.0

refresh

Method name Return type Available since
refresh void

release

Method name Return type Available since
release void

release(boolean)

Method name Return type Available since
release(boolean) void

removeAllWorkflowPermissions

Method name Return type Available since
removeAllWorkflowPermissions void

removeChild(StoreElement)

Method name Return type Available since
removeChild(StoreElement) void

removeFromPackage(Package)

Method name Return type Available since
removeFromPackage(Package) void

removeLifespan

Method name Return type Available since
removeLifespan void

removePermission(Group)

Method name Return type Available since
removePermission(Group) void

removePermission(User)

Method name Return type Available since
removePermission(User) void

removePermission(User[])

Method name Return type Available since
removePermission(User[]) void

removeTask

Method name Return type Available since
removeTask void

removeWorkflowPermission(Workflow)

Method name Return type Available since
removeWorkflowPermission(Workflow) void

replaceChild(StoreElement, StoreElement)

Method name Return type Available since
replaceChild(StoreElement, StoreElement) void

revert(Revision, boolean, EnumSet)

Method name Return type Available since
revert(Revision, boolean, EnumSet) void

save

Method name Return type Available since
save void

save(String)

Method name Return type Available since
save(String) void

save(String, boolean)

Method name Return type Available since
save(String, boolean) void

set(String, Object)

Method name Return type Available since
set(String, Object) Object

setChangeState(int)

Method name Return type Available since
setChangeState(int) void

setColor(Color)

Method name Return type Available since
setColor(Color) void

setDisplayName(Language, String)

Method name Return type Available since
setDisplayName(Language, String) void

setFormData(FormData)

Method name Return type Available since
setFormData(FormData) void

setInheritWorkflowPermission(boolean)

Method name Return type Available since
setInheritWorkflowPermission(boolean) void

setLifespan(long, long)

Method name Return type Available since
setLifespan(long, long) void

setLock(boolean)

Method name Return type Available since
setLock(boolean) void

setLock(boolean, boolean)

Method name Return type Available since
setLock(boolean, boolean) void

setMetaFormData(FormData)

Method name Return type Available since
setMetaFormData(FormData) void

setName(String)

Method name Return type Available since
setName(String) void

setPermission(Group, Permission)

Method name Return type Available since
setPermission(Group, Permission) void

setPermission(User, Permission)

Method name Return type Available since
setPermission(User, Permission) void

setPermission(User[], Permission)

Method name Return type Available since
setPermission(User[], Permission) void

setTask(Task)

Method name Return type Available since
setTask(Task) void

setTemplate(SectionTemplate)

Method name Return type Available since
setTemplate(SectionTemplate) void

setUid(String)

Method name Return type Available since
setUid(String) void

setWorkflowPermission(WorkflowPermission)

Method name Return type Available since
setWorkflowPermission(WorkflowPermission) void

setWorkflowPermissions(WorkflowPermission[])

Method name Return type Available since
setWorkflowPermissions(WorkflowPermission[]) void

setWriteLock(boolean)

Method name Return type Available since
setWriteLock(boolean) void

toJson

Convert to JSON string representtion (only handles Maps, Collections, Arrays, Numbers, and Strings)
Method name Return type Available since
toJson String 4.2.14

toString

Method name Return type Available since
toString String

toXml

Method name Return type Available since
toXml String

toXml(boolean)

Method name Return type Available since
toXml(boolean) String

toXml(boolean, boolean)

Method name Return type Available since
toXml(boolean, boolean) String

type

Method name Return type Available since
type String

© 2005 - 2015 e-Spirit AG | All rights reserved. | Last change: 2014-01-08