Startseite / Vorlagenentwicklung / Vorlagensyntax / Datentypen / Section

Datentyp Section

Methoden auf Section-Objekten

In der unten angegebenen Tabelle werden alle Methoden aufgelistet, die auf Objekten von Datentyp Section aufgerufen werden können:

Methodenname	Rückgabetyp	Kurzbeschreibung	Verfügbar seit
addToPackage(Package)	void	Adds this node, all children and referenced nodes which are PackagePoolItems to the specified package.	3.1.158
asRevisionProvider	ElementProvider	Return an ElementProvider on this HistoryProvider.	4.0.49
changeDate	Date	Änderungsdatum des Objektes	4.0.0
clearCachedData	void	Clear any cache holding the data object.	4.0
compareTo(Object)	int
contrastWith(IDProvider)	Set	Contrast the element with another one.	4.0.52
delete	void	Deletes this storeelement.	2.3
depth	int	Tiefe des Objektes in Bezug auf den Wurzelknoten (hat die Tiefe 0)	4.0.0
equals(Object)	boolean
excludeFromOutput(Language)	void	Excludes this section from the output for the given language.	3.0
exportStoreElement(OutputStream, ExportHandler)	void	Exports this storeelement as zip file to the given outputstream.	3.0.7
getChangeState	int	Returns the change state of this PackagePoolItem either UNMODIFIED, MODIFIED or BLOCKED.	3.1.172
getChildCount	int		3.0.115
getChildIndex(StoreElement)	int		3.0.115
getChildren	Listable	Kind-Elemente des Objektes	4.0
getChildren(Class)	Listable	Get the element's direct children that are instances of the given type.	4.0
getChildren(Class, boolean)	Listable	Get the element's children that are instances of the given type.	4.0
getChildren(Filter$TypedFilter, boolean)	Listable	Get the element's children passing the given typed filter.	4.0
getClass	Class	Klasse des aufrufenden Objektes
getClientUrl(ClientUrlAgent$ClientType)	String	get the client url for the specified element and the current language	5.0.10
getColor	Color	Get the color of the current state.	3.1.168
getCreateWorkflowPermission(Workflow)	WorkflowPermission	Return workflow permission object for the given workflow.	4.0.120
getDefinedPrincipalPermissions	List	Returns a list of Principal's for which permissions are defined at this storeelement.	3.1.187
getDisplayName(Language)	String	Return the display name (label) for the specified language - if no language specific label is defined for this language the value for the master language is returned.	4.0.13
getEditor	User	Letzter Bearbeiter des Objektes	2.3
getElementType	String		3.0.7
getFirstChild	StoreElement	Provides the first child node.	4.0.17
getFormData	FormData	Gets the formdata container of this element.	4.2.440
getHistory	List	Returns the revisions history of this storeelement, starting with the newest revision descending to the initial revision.	4.0.34
getHistory(Date, Date, int, Filter)	List	Returns a list of revisions of this store element in descending order.	4.0.40
getId	long	ID des Objektes	4.0.90
getInRevision(Revision)	IDProvider	Get this element in the state of the given revision.	4.0.52
getIncomingReferences	ReferenceEntry[]	Returns all incoming references of this StoreElement.	3.1.172
getInheritedPrincipalPermissions	List	Returns a list of Principal's for which permissions are defined at this storelement including the inherited permissions on parent path.	3.1.187
getJavaClientUrl	String	get the java client url for the specified element and the current language	5.0.10
getLanguageInfo(Language)	LanguageInfo	Returns the LanguageInfo node for the given language	4.0
getLastChanged	long		2.3
getLifespan	long[]	Get the lifespan of the current section if there is one defined.	3.0
getLongID	Long		3.1
getMetaFormData	FormData	Returns the formdata container of this element or null if there is no meta data template defined for project.	4.2.450
getName	String	Get the name of the section	3.0
getNextSibling	StoreElement	Provides the next sibling store element.	4.0.17
getOutgoingReferences	ReferenceEntry[]	Returns all outgoing references of this StoreElement.	3.1.172
getPackage	Package	Returns the Package this item belongs to or null.	3.1.158
getPackageName	String	Returns the name of the package this item belongs to.	3.1.158
getParent	IDProvider	Return parent IDProvider which is null for deleted elements or store-roots.	4.0.17
getPermission	Permission	Returns the permission object for the current user even if permission checking is turned off.	2.3
getPermission(Group)	Permission	Returns the correct permission object even if permission checking is turned off.	2.3
getPermission(User)	Permission	Returns the correct permission object even if permission checking is turned off.	2.3
getPreviousSibling	StoreElement	Provides the previous sibling store element.	5.2.200804
getProject	Project	Returns the belonging project of this storeelement.	4.0
getReferenceName	String	Provided the element's reference name.	4.0.17
getReferences	Set	Returns current outgoing references of this store element.	4.0.17
getReleaseRevision	Revision		4.0
getReleaseStatus	int	Returns the release state of this storeelement (CHANGED or RELEASED or NEVER_RELEASED)	4.0.13
getReleasedBy	User	The last user who released this node or null if this node has never been released.	4.1.9
getRevision	Revision		4.0
getStore	Store	Provides the store related to the element.	2.3
getTask	Task	Get the possible assigned Task or null.	3.1.168
getTemplate	Template	Returns the template of this element.	3.0
getTreePermission	PermissionMap	Return permissions combined from defined and inherited permissions for current user.	3.0.59
getUid	String	Referenzname/UID eines Objektes	4.0
getUidType	IDProvider$UidType	Returns the unique identifier type of this IDProvider if it has a unique identifier otherwise throws an UnsupportedOperationException!	4.0
getWebeditUrl	String	get the webedit url for the specified element and the current language	5.0.10
getWorkflowPermission(Workflow)	WorkflowPermission	Return workflow permission object for the given workflow.	3.0.1
getWorkflowPermissions	WorkflowPermission[]	Return all existing workflow permissions.	3.0.1
getWriteLock	boolean	A write lock is a flag to prevent changes e.g. while a workflow is active for this element.	3.0.4
hasIncomingReferences	boolean	Returns true if this StoreElement has incoming references.	4.0
hasMeta	boolean	Indicates that any meta data is set for this element.	4.0.120
hasPermissions	boolean	Indicates whether for this element permissions are defined or not.	4.0.17
hasTask	boolean	Does this elements has a Task assigned?	3.1.168
hasUid	boolean	Returns true if this IDProvider has a unique identifier like e.g. medias, false otherwise.	4.0
id	Long		4.0.0
importStoreElement(ZipFile, ImportHandler)	StoreElement	Imports the first root node from the given zip exportfile.	3.0.7
importStoreElements(ZipFile, ImportHandler)	Listable	Imports all root nodes from the given zip exportfile.	4.0.47
includeInOutput(Language)	void	Includes this section in the output for the given language.	3.0
inheritWorkflowPermission	boolean	Returns a boolean state, whether the workflow permissions should be inherited for this StoreElement or not.	3.0.1
isAddable(Package)	boolean	Return true if this node is neither an package nor an subscribed item and is an allowed content type for the specified package.	3.1.158
isCase(Object)	boolean
isChangeable	boolean	Checks if this PackagePoolItem is changeable.	3.1.158
isDeleted	boolean	Returns the state of deletion. true if element is deleted and false if its not	4.2.9
isExportSupported	boolean	Checks if the element supports export.	3.0.1
isFolder	boolean	Checks if the element is a folder.	3.0
isImportSupported	boolean	Checks if the element supports import.	3.0.1
isInLifespan	boolean	Indicates whether the actual time is included in the lifespan of this section.	4.0
isInLifespan(long)	boolean	Indicates whether the given timestamp is included in the lifespan of this section.	4.2.200
isInOutputIncluded(Language)	boolean	Checks if this section is included in the output for the given language.	3.0
isInReleaseStore	boolean	Checks if this storeelement exists in the release representation of the belonging store.	4.1.9
isLockSupported	boolean	Check this before using any lock method.	2.3
isLocked	boolean	Checks if this node is locked by this session.	3.1.158
isLockedOnServer(boolean)	boolean	Checks if this storeelement is locked on the server.	3.1.158
isNull	boolean	Prüft, ob ein Ausdruck Null ist
isPackageItem	boolean	Return true if the item is part of a Package.	3.1.158
isPermissionSupported	boolean	Indicates whether this element supports permissions or not.	2.3
isReference	boolean	Is this a reference section?	3.0
isReleaseSupported	boolean	Indicates wether this element supports release or not.	4.1.9
isReleased	boolean	Returns true if this element is currently released (not changed).	5.0.414
isSubscribedItem	boolean	Return true if this node has been imported by a Subscription.	3.1.158
isWorkflowAllowed(Workflow, User)	boolean	Returns true if workflow is not null and is explicitly allowed to be started on this element by given user or workflow is null and any workflow is allowed to be started on this element by given user, false otherwise.	3.0.1
isWorkflowSupported	boolean	Checks if a workflow might be executed at the element.	3.0.1
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	Insert child at last position.	4.0
moveChild(IDProvider, int)	void	Insert child at index position.	4.0
print	void		4.0.0
refresh	void	Refreshes this element if there is a newer version on the server.	2.3
release	void	Release this node and all childs.	4.1.9
release(boolean)	void	Release this node and optionally all childs	4.0
removeAllWorkflowPermissions	void		3.0.1
removeChild(StoreElement)	void	Removes the given child from this element.	3.0.7
removeFromPackage(Package)	void	Removes this node, all children and nodes referencing this nodes which are PackagePoolItems's from the specified package.	3.1.192
removeLifespan	void	Remove lifespan of the current section.	3.0
removePermission(Group)	void	Removes the permission object for a given group.	2.3
removePermission(User)	void	Removes the permission object for the given user.	2.3
removePermission(User[])	void	Removes the permission object for several given users.	2.3
removeTask	void	Removes a already set Task.	3.1.168
removeWorkflowPermission(Workflow)	void		3.0.1
replaceChild(StoreElement, StoreElement)	void	Replaces an element's child by another child.	3.0.7
revert(Revision, boolean, EnumSet)	void	Reverts this store element to the given FSRevision.	4.0.44
save	void	Saves the node and all childs, shortcut for save(null, true).	2.3
save(String)	void	Saves the node and all childs.	4.0
save(String, boolean)	void	Saves this node.	4.0
set(String, Object)	Object
setChangeState(int)	void	Sets the change state for this PackagePoolItem.	3.1.172
setColor(Color)	void	Set a new color.	3.1.168
setDisplayName(Language, String)	void	Sets the display name (label) for the specified language.	5.1.205
setFormData(FormData)	void	Sets the given formdata container of this element.	4.2.440
setInheritWorkflowPermission(boolean)	void	Sets a boolean flag to enable or disable the inheritance of workflow permissions for this StoreElement.	3.0.1
setLifespan(long, long)	void	Set the lifespan of the current section.	3.0
setLock(boolean)	void	Lock or unlock this element and all children.	2.3
setLock(boolean, boolean)	void	Lock or unlock this element, if recursive == true all children are also (un)locked.	4.0.17
setMetaFormData(FormData)	void	Sets the given formdata container of this element. Removes meta data if null is provided.	4.2.450
setName(String)	void	Set the name of a section	3.0
setPermission(Group, Permission)	void	Set the defined permission for the given group.	2.3
setPermission(User, Permission)	void	Set the defined permission for the given user.	2.3
setPermission(User[], Permission)	void	Set the defined permission for several users.	2.3
setTask(Task)	void	Set the given Task.	3.1.168
setTemplate(SectionTemplate)	void	Set the template for this section.	4.1.25
setUid(String)	void	Sets the unique identifier.	4.0
setWorkflowPermission(WorkflowPermission)	void		3.0.1
setWorkflowPermissions(WorkflowPermission[])	void		3.0.1
setWriteLock(boolean)	void	A write lock is a flag to prevent changes e.g. while a workflow is active for this element.	3.0.4
toJSON	String	Convert to a JSON-compatible string representation including necessary quotes and escaping for immediate use. Handles Maps, Collections, Arrays, Numbers, Strings, Boolean, Date, and JsonElement. A date instance will be converted to an ISO-8601 formatted date string. Any object other than above will be converted using its 'toString()' value.	5.2.11
toString	String
toXml	String	Creates the xml representation of the node with all children but without indentation and line breaks.	2.3
toXml(boolean)	String	Creates the xml representation with or without all children depending on the given parameter.	4.0
toXml(boolean, boolean)	String	Creates the xml representation with or without children, line breaks and indentation depending on the given parameters.	4.0
type	String

addToPackage(Package)

Adds this node, all children and referenced nodes which are PackagePoolItems to the specified package.

Methodenname	Rückgabetyp	Verfügbar seit
addToPackage(Package)	void	3.1.158

Übersicht

asRevisionProvider

Return an ElementProvider on this HistoryProvider.

Methodenname	Rückgabetyp	Verfügbar seit
asRevisionProvider	ElementProvider	4.0.49

Übersicht

changeDate

Die Methode changeDate liefert das Änderungsdatum des Objektes zurück.

Sie wird häufig im Zusammenhang mit dem Systemobjekt #global verwendet. Mit diesem Systemobjekt kann das Änderungsdatum eines speziellen Objekts ermittelt werden:

#global.node.changeDate ermittelt das Änderungsdatum einer Seitenreferenz
#global.page.changeDate ermittelt das Änderungsdatum einer Seite
#global.section.changeDate ermittelt das Änderungsdatum eines Absatzes

Methodenname	Rückgabetyp	Verfügbar seit
changeDate	Date	4.0.0

Übersicht

clearCachedData

Clear any cache holding the data object.

Methodenname	Rückgabetyp	Verfügbar seit
clearCachedData	void	4.0

Übersicht

compareTo(Object)

Methodenname	Rückgabetyp	Verfügbar seit
compareTo(Object)	int

Übersicht

contrastWith(IDProvider)

Contrast the element with another one.

Methodenname	Rückgabetyp	Verfügbar seit
contrastWith(IDProvider)	Set	4.0.52

Übersicht

delete

Deletes this storeelement.

Methodenname	Rückgabetyp	Verfügbar seit
delete	void	2.3

Übersicht

depth

Die Methode depth liefert die Tiefe des Objektes in Bezug auf den Wurzelknoten zurück. Die Zählung beginnt bei 0 für den Wurzelknoten.

Die Methode depth wird häufig im Zusammenhang mit dem Systemobjekt #global verwendet. Mit diesem Systemobjekt kann die Tiefe eines speziellen Objekts ermittelt werden:

#global.node.depth ermittelt die Tiefe der Seitenreferenz
#global.page.depth ermittelt die Tiefe der Seite
#global.section.depth ermittelt die Tiefe des Absatzes

Methodenname	Rückgabetyp	Verfügbar seit
depth	int	4.0.0

Übersicht

equals(Object)

Methodenname	Rückgabetyp	Verfügbar seit
equals(Object)	boolean

Übersicht

excludeFromOutput(Language)

Excludes this section from the output for the given language.

Methodenname	Rückgabetyp	Verfügbar seit
excludeFromOutput(Language)	void	3.0

Übersicht

exportStoreElement(OutputStream, ExportHandler)

Exports this storeelement as zip file to the given outputstream.

Methodenname	Rückgabetyp	Verfügbar seit
exportStoreElement(OutputStream, ExportHandler)	void	3.0.7

Übersicht

getChangeState

Returns the change state of this PackagePoolItem either UNMODIFIED, MODIFIED or BLOCKED.

Methodenname	Rückgabetyp	Verfügbar seit
getChangeState	int	3.1.172

Übersicht

getChildCount

Methodenname	Rückgabetyp	Verfügbar seit
getChildCount	int	3.0.115

Übersicht

getChildIndex(StoreElement)

Methodenname	Rückgabetyp	Verfügbar seit
getChildIndex(StoreElement)	int	3.0.115

Übersicht

getChildren

Die Methode getChildren liefert die direkten Kinder des Objektes zurück.

Methodenname	Rückgabetyp	Verfügbar seit
getChildren	Listable	4.0

Übersicht

getChildren(Class)

Get the element's direct children that are instances of the given type.

Methodenname	Rückgabetyp	Verfügbar seit
getChildren(Class)	Listable	4.0

Übersicht

getChildren(Class, boolean)

Get the element's children that are instances of the given type.

Methodenname	Rückgabetyp	Verfügbar seit
getChildren(Class, boolean)	Listable	4.0

Übersicht

getChildren(Filter$TypedFilter, boolean)

Get the element's children passing the given typed filter.

Methodenname	Rückgabetyp	Verfügbar seit
getChildren(Filter$TypedFilter, boolean)	Listable	4.0

Übersicht

getClass

Die Methode .getClass() (in Bean-Syntax: .class) liefert die Klasse des aufrufendes Objektes zurück (vgl. java.lang.Class).

Aufruf:

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

Ausgabe:

java.lang.String

Methodenname	Rückgabetyp	Verfügbar seit
getClass	Class

Übersicht

getClientUrl(ClientUrlAgent$ClientType)

get the client url for the specified element and the current language

Methodenname	Rückgabetyp	Verfügbar seit
getClientUrl(ClientUrlAgent$ClientType)	String	5.0.10

Übersicht

getColor

Get the color of the current state.

Methodenname	Rückgabetyp	Verfügbar seit
getColor	Color	3.1.168

Übersicht

getCreateWorkflowPermission(Workflow)

Return workflow permission object for the given workflow.

Methodenname	Rückgabetyp	Verfügbar seit
getCreateWorkflowPermission(Workflow)	WorkflowPermission	4.0.120

Übersicht

getDefinedPrincipalPermissions

Returns a list of Principal's for which permissions are defined at this storeelement.

Methodenname	Rückgabetyp	Verfügbar seit
getDefinedPrincipalPermissions	List	3.1.187

Übersicht

getDisplayName(Language)

Return the display name (label) for the specified language - if no language specific label is defined for this language the value for the master language is returned.

Methodenname	Rückgabetyp	Verfügbar seit
getDisplayName(Language)	String	4.0.13

Übersicht

getEditor

Die Methode getEditor gibt den Redakteur, der ein Objekt zuletzt bearbeitet hat, zurück.

Sie wird häufig im Zusammenhang mit dem Systemobjekt #global verwendet. Mit diesem Systemobjekt kann der letzte Bearbeiter eines speziellen Objektes ermittelt werden:

#global.node.editor ermittelt den letzten Bearbeiter einer Seitenreferenz
#global.page.editor ermittelt den letzten Bearbeiter einer Seite
#global.section.editor ermittelt den letzten Bearbeiter eines Absatzes

Methodenname	Rückgabetyp	Verfügbar seit
getEditor	User	2.3

Übersicht

getElementType

Methodenname	Rückgabetyp	Verfügbar seit
getElementType	String	3.0.7

Übersicht

getFirstChild

Provides the first child node.

Methodenname	Rückgabetyp	Verfügbar seit
getFirstChild	StoreElement	4.0.17

Übersicht

getFormData

Gets the formdata container of this element.

Methodenname	Rückgabetyp	Verfügbar seit
getFormData	FormData	4.2.440

Übersicht

getHistory

Returns the revisions history of this storeelement, starting with the newest revision descending to the initial revision.

Methodenname	Rückgabetyp	Verfügbar seit
getHistory	List	4.0.34

Übersicht

getHistory(Date, Date, int, Filter)

Returns a list of revisions of this store element in descending order.

Methodenname	Rückgabetyp	Verfügbar seit
getHistory(Date, Date, int, Filter)	List	4.0.40

Übersicht

getId

Die Methode getId liefert die eindeutige ID des Objektes zurück.

Sie wird häufig im Zusammenhang mit dem Systemobjekt #global verwendet. Mit diesem Systemobjekt kann für ein spezielles Objekt die entsprechende eindeutige ID ermittelt werden:

#global.node.id ermittelt die ID einer Seitenreferenz
#global.page.id ermittelt die ID einer Seite
#global.section.id ermittelt die ID eines Absatzes

Methodenname	Rückgabetyp	Verfügbar seit
getId	long	4.0.90

Übersicht

getInRevision(Revision)

Get this element in the state of the given revision.

Methodenname	Rückgabetyp	Verfügbar seit
getInRevision(Revision)	IDProvider	4.0.52

Übersicht

getIncomingReferences

Returns all incoming references of this StoreElement.

Methodenname	Rückgabetyp	Verfügbar seit
getIncomingReferences	ReferenceEntry[]	3.1.172

Übersicht

getInheritedPrincipalPermissions

Returns a list of Principal's for which permissions are defined at this storelement including the inherited permissions on parent path.

Methodenname	Rückgabetyp	Verfügbar seit
getInheritedPrincipalPermissions	List	3.1.187

Übersicht

getJavaClientUrl

get the java client url for the specified element and the current language

Methodenname	Rückgabetyp	Verfügbar seit
getJavaClientUrl	String	5.0.10

Übersicht

getLanguageInfo(Language)

Returns the LanguageInfo node for the given language

Methodenname	Rückgabetyp	Verfügbar seit
getLanguageInfo(Language)	LanguageInfo	4.0

Übersicht

getLastChanged

Methodenname	Rückgabetyp	Verfügbar seit
getLastChanged	long	2.3

Übersicht

getLifespan

Get the lifespan of the current section if there is one defined.

Methodenname	Rückgabetyp	Verfügbar seit
getLifespan	long[]	3.0

Übersicht

getLongID

Methodenname	Rückgabetyp	Verfügbar seit
getLongID	Long	3.1

Übersicht

getMetaFormData

Returns the formdata container of this element or null if there is no meta data template defined for project.

Methodenname	Rückgabetyp	Verfügbar seit
getMetaFormData	FormData	4.2.450

Übersicht

getName

Get the name of the section

Methodenname	Rückgabetyp	Verfügbar seit
getName	String	3.0

Übersicht

getNextSibling

Provides the next sibling store element.

Methodenname	Rückgabetyp	Verfügbar seit
getNextSibling	StoreElement	4.0.17

Übersicht

getOutgoingReferences

Returns all outgoing references of this StoreElement.

Methodenname	Rückgabetyp	Verfügbar seit
getOutgoingReferences	ReferenceEntry[]	3.1.172

Übersicht

getPackage

Returns the Package this item belongs to or null.

Methodenname	Rückgabetyp	Verfügbar seit
getPackage	Package	3.1.158

Übersicht

getPackageName

Returns the name of the package this item belongs to.

Methodenname	Rückgabetyp	Verfügbar seit
getPackageName	String	3.1.158

Übersicht

getParent

Return parent IDProvider which is null for deleted elements or store-roots.

Methodenname	Rückgabetyp	Verfügbar seit
getParent	IDProvider	4.0.17

Übersicht

getPermission

Returns the permission object for the current user even if permission checking is turned off.

Methodenname	Rückgabetyp	Verfügbar seit
getPermission	Permission	2.3

Übersicht

getPermission(Group)

Returns the correct permission object even if permission checking is turned off.

Methodenname	Rückgabetyp	Verfügbar seit
getPermission(Group)	Permission	2.3

Übersicht

getPermission(User)

Returns the correct permission object even if permission checking is turned off.

Methodenname	Rückgabetyp	Verfügbar seit
getPermission(User)	Permission	2.3

Übersicht

getPreviousSibling

Provides the previous sibling store element.

Methodenname	Rückgabetyp	Verfügbar seit
getPreviousSibling	StoreElement	5.2.200804

Übersicht

getProject

Returns the belonging project of this storeelement.

Methodenname	Rückgabetyp	Verfügbar seit
getProject	Project	4.0

Übersicht

getReferenceName

Provided the element's reference name.

Methodenname	Rückgabetyp	Verfügbar seit
getReferenceName	String	4.0.17

Übersicht

getReferences

Returns current outgoing references of this store element.

Methodenname	Rückgabetyp	Verfügbar seit
getReferences	Set	4.0.17

Übersicht

getReleaseRevision

Methodenname	Rückgabetyp	Verfügbar seit
getReleaseRevision	Revision	4.0

Übersicht

getReleaseStatus

Returns the release state of this storeelement (CHANGED or RELEASED or NEVER_RELEASED)

Methodenname	Rückgabetyp	Verfügbar seit
getReleaseStatus	int	4.0.13

Übersicht

getReleasedBy

The last user who released this node or null if this node has never been released.

Methodenname	Rückgabetyp	Verfügbar seit
getReleasedBy	User	4.1.9

Übersicht

getRevision

Methodenname	Rückgabetyp	Verfügbar seit
getRevision	Revision	4.0

Übersicht

getStore

Provides the store related to the element.

Methodenname	Rückgabetyp	Verfügbar seit
getStore	Store	2.3

Übersicht

getTask

Get the possible assigned Task or null.

Methodenname	Rückgabetyp	Verfügbar seit
getTask	Task	3.1.168

Übersicht

getTemplate

Returns the template of this element.

Methodenname	Rückgabetyp	Verfügbar seit
getTemplate	Template	3.0

Übersicht

getTreePermission

Return permissions combined from defined and inherited permissions for current user.

Methodenname	Rückgabetyp	Verfügbar seit
getTreePermission	PermissionMap	3.0.59

Übersicht

getUid

Die Methode getUid liefert den Referenzname bzw. die UID ("Unified Identifier") eines Objektes zurück.

Methodenname	Rückgabetyp	Verfügbar seit
getUid	String	4.0

Übersicht

getUidType

Returns the unique identifier type of this IDProvider if it has a unique identifier otherwise throws an UnsupportedOperationException!

Methodenname	Rückgabetyp	Verfügbar seit
getUidType	IDProvider$UidType	4.0

Übersicht

getWebeditUrl

get the webedit url for the specified element and the current language

Methodenname	Rückgabetyp	Verfügbar seit
getWebeditUrl	String	5.0.10

Übersicht

getWorkflowPermission(Workflow)

Return workflow permission object for the given workflow.

Methodenname	Rückgabetyp	Verfügbar seit
getWorkflowPermission(Workflow)	WorkflowPermission	3.0.1

Übersicht

getWorkflowPermissions

Return all existing workflow permissions.

Methodenname	Rückgabetyp	Verfügbar seit
getWorkflowPermissions	WorkflowPermission[]	3.0.1

Übersicht

getWriteLock

A write lock is a flag to prevent changes e.g. while a workflow is active for this element.

Methodenname	Rückgabetyp	Verfügbar seit
getWriteLock	boolean	3.0.4

Übersicht

hasIncomingReferences

Returns true if this StoreElement has incoming references.

Methodenname	Rückgabetyp	Verfügbar seit
hasIncomingReferences	boolean	4.0

Übersicht

hasMeta

Indicates that any meta data is set for this element.

Methodenname	Rückgabetyp	Verfügbar seit
hasMeta	boolean	4.0.120

Übersicht

hasPermissions

Indicates whether for this element permissions are defined or not.

Methodenname	Rückgabetyp	Verfügbar seit
hasPermissions	boolean	4.0.17

Übersicht

hasTask

Does this elements has a Task assigned?

Methodenname	Rückgabetyp	Verfügbar seit
hasTask	boolean	3.1.168

Übersicht

hasUid

Returns true if this IDProvider has a unique identifier like e.g. medias, false otherwise.

Methodenname	Rückgabetyp	Verfügbar seit
hasUid	boolean	4.0

Übersicht

id

Methodenname	Rückgabetyp	Verfügbar seit
id	Long	4.0.0

Übersicht

importStoreElement(ZipFile, ImportHandler)

Imports the first root node from the given zip exportfile.

Methodenname	Rückgabetyp	Verfügbar seit
importStoreElement(ZipFile, ImportHandler)	StoreElement	3.0.7

Übersicht

importStoreElements(ZipFile, ImportHandler)

Imports all root nodes from the given zip exportfile.

Methodenname	Rückgabetyp	Verfügbar seit
importStoreElements(ZipFile, ImportHandler)	Listable	4.0.47

Übersicht

includeInOutput(Language)

Includes this section in the output for the given language.

Methodenname	Rückgabetyp	Verfügbar seit
includeInOutput(Language)	void	3.0

Übersicht

inheritWorkflowPermission

Returns a boolean state, whether the workflow permissions should be inherited for this StoreElement or not.

Methodenname	Rückgabetyp	Verfügbar seit
inheritWorkflowPermission	boolean	3.0.1

Übersicht

isAddable(Package)

Return true if this node is neither an package nor an subscribed item and is an allowed content type for the specified package.

Methodenname	Rückgabetyp	Verfügbar seit
isAddable(Package)	boolean	3.1.158

Übersicht

isCase(Object)

Methodenname	Rückgabetyp	Verfügbar seit
isCase(Object)	boolean

Übersicht

isChangeable

Checks if this PackagePoolItem is changeable.

Methodenname	Rückgabetyp	Verfügbar seit
isChangeable	boolean	3.1.158

Übersicht

isDeleted

Returns the state of deletion. true if element is deleted and false if its not

Methodenname	Rückgabetyp	Verfügbar seit
isDeleted	boolean	4.2.9

Übersicht

isExportSupported

Checks if the element supports export.

Methodenname	Rückgabetyp	Verfügbar seit
isExportSupported	boolean	3.0.1

Übersicht

isFolder

Checks if the element is a folder.

Methodenname	Rückgabetyp	Verfügbar seit
isFolder	boolean	3.0

Übersicht

isImportSupported

Checks if the element supports import.

Methodenname	Rückgabetyp	Verfügbar seit
isImportSupported	boolean	3.0.1

Übersicht

isInLifespan

Indicates whether the actual time is included in the lifespan of this section.

Methodenname	Rückgabetyp	Verfügbar seit
isInLifespan	boolean	4.0

Übersicht

isInLifespan(long)

Indicates whether the given timestamp is included in the lifespan of this section.

Methodenname	Rückgabetyp	Verfügbar seit
isInLifespan(long)	boolean	4.2.200

Übersicht

isInOutputIncluded(Language)

Checks if this section is included in the output for the given language.

Methodenname	Rückgabetyp	Verfügbar seit
isInOutputIncluded(Language)	boolean	3.0

Übersicht

isInReleaseStore

Checks if this storeelement exists in the release representation of the belonging store.

Methodenname	Rückgabetyp	Verfügbar seit
isInReleaseStore	boolean	4.1.9

Übersicht

isLockSupported

Check this before using any lock method.

Methodenname	Rückgabetyp	Verfügbar seit
isLockSupported	boolean	2.3

Übersicht

isLocked

Checks if this node is locked by this session.

Methodenname	Rückgabetyp	Verfügbar seit
isLocked	boolean	3.1.158

Übersicht

isLockedOnServer(boolean)

Checks if this storeelement is locked on the server.

Methodenname	Rückgabetyp	Verfügbar seit
isLockedOnServer(boolean)	boolean	3.1.158

Übersicht

isNull

Die Methode .isNull() (in Bean-Syntax: .isNull) prüft, ob ein Ausdruck bzw. Objekt Null ist, z. B. storeElement.isNull(). Bei Objekten mit komplexen Werten oder Objekten entscheidet das Objekt, wann es null ist. Der Datentyp DomElement enthält beispielsweise immer ein leeres Dokument, ist also nie null. Die Prüfung einer leeren DOM-Editor-Eingabekomponente mit der Methode .isNull() liefert daher den Wert false, während die Prüfung der Komponente auf .isEmpty() den Wert true liefern würde.

Die Methode .isNull() gibt einen booleschen Wert als Ergebnis der Prüfung zurück. true (=wahr) ist die Prüfung, wenn der Ausdruck bzw. das Objekt Null ist und false (=unwahr) wenn nicht.

Methodenname	Rückgabetyp	Verfügbar seit
isNull	boolean

Übersicht

isPackageItem

Return true if the item is part of a Package.

Methodenname	Rückgabetyp	Verfügbar seit
isPackageItem	boolean	3.1.158

Übersicht

isPermissionSupported

Indicates whether this element supports permissions or not.

Methodenname	Rückgabetyp	Verfügbar seit
isPermissionSupported	boolean	2.3

Übersicht

isReference

Is this a reference section?

Methodenname	Rückgabetyp	Verfügbar seit
isReference	boolean	3.0

Übersicht

isReleaseSupported

Indicates wether this element supports release or not.

Methodenname	Rückgabetyp	Verfügbar seit
isReleaseSupported	boolean	4.1.9

Übersicht

isReleased

Returns true if this element is currently released (not changed).

Methodenname	Rückgabetyp	Verfügbar seit
isReleased	boolean	5.0.414

Übersicht

isSubscribedItem

Return true if this node has been imported by a Subscription.

Methodenname	Rückgabetyp	Verfügbar seit
isSubscribedItem	boolean	3.1.158

Übersicht

isWorkflowAllowed(Workflow, User)

Returns true if workflow is not null and is explicitly allowed to be started on this element by given user or workflow is null and any workflow is allowed to be started on this element by given user, false otherwise.

Methodenname	Rückgabetyp	Verfügbar seit
isWorkflowAllowed(Workflow, User)	boolean	3.0.1

Übersicht

isWorkflowSupported

Checks if a workflow might be executed at the element.

Methodenname	Rückgabetyp	Verfügbar seit
isWorkflowSupported	boolean	3.0.1

Übersicht

meta(String)

get a meta value by name

Methodenname	Rückgabetyp	Verfügbar seit
meta(String)	Object	4.0

Übersicht

meta(String, String)

get a meta value by name in mode 'inherit', 'add', or 'none'

Methodenname	Rückgabetyp	Verfügbar seit
meta(String, String)	Object	4.0

Übersicht

moveChild(IDProvider)

Insert child at last position.

Methodenname	Rückgabetyp	Verfügbar seit
moveChild(IDProvider)	void	4.0

Übersicht

moveChild(IDProvider, int)

Insert child at index position.

Methodenname	Rückgabetyp	Verfügbar seit
moveChild(IDProvider, int)	void	4.0

Übersicht

print

Methodenname	Rückgabetyp	Verfügbar seit
print	void	4.0.0

Übersicht

refresh

Refreshes this element if there is a newer version on the server.

Methodenname	Rückgabetyp	Verfügbar seit
refresh	void	2.3

Übersicht

release

Release this node and all childs.

Methodenname	Rückgabetyp	Verfügbar seit
release	void	4.1.9

Übersicht

release(boolean)

Release this node and optionally all childs

Methodenname	Rückgabetyp	Verfügbar seit
release(boolean)	void	4.0

Übersicht

removeAllWorkflowPermissions

Methodenname	Rückgabetyp	Verfügbar seit
removeAllWorkflowPermissions	void	3.0.1

Übersicht

removeChild(StoreElement)

Removes the given child from this element.

Methodenname	Rückgabetyp	Verfügbar seit
removeChild(StoreElement)	void	3.0.7

Übersicht

removeFromPackage(Package)

Removes this node, all children and nodes referencing this nodes which are PackagePoolItems's from the specified package.

Methodenname	Rückgabetyp	Verfügbar seit
removeFromPackage(Package)	void	3.1.192

Übersicht

removeLifespan

Remove lifespan of the current section.

Methodenname	Rückgabetyp	Verfügbar seit
removeLifespan	void	3.0

Übersicht

removePermission(Group)

Removes the permission object for a given group.

Methodenname	Rückgabetyp	Verfügbar seit
removePermission(Group)	void	2.3

Übersicht

removePermission(User)

Removes the permission object for the given user.

Methodenname	Rückgabetyp	Verfügbar seit
removePermission(User)	void	2.3

Übersicht

removePermission(User[])

Removes the permission object for several given users.

Methodenname	Rückgabetyp	Verfügbar seit
removePermission(User[])	void	2.3

Übersicht

removeTask

Removes a already set Task.

Methodenname	Rückgabetyp	Verfügbar seit
removeTask	void	3.1.168

Übersicht

removeWorkflowPermission(Workflow)

Methodenname	Rückgabetyp	Verfügbar seit
removeWorkflowPermission(Workflow)	void	3.0.1

Übersicht

replaceChild(StoreElement, StoreElement)

Replaces an element's child by another child.

Methodenname	Rückgabetyp	Verfügbar seit
replaceChild(StoreElement, StoreElement)	void	3.0.7

Übersicht

revert(Revision, boolean, EnumSet)

Reverts this store element to the given FSRevision.

Methodenname	Rückgabetyp	Verfügbar seit
revert(Revision, boolean, EnumSet)	void	4.0.44

Übersicht

save

Saves the node and all childs, shortcut for save(null, true).

Methodenname	Rückgabetyp	Verfügbar seit
save	void	2.3

Übersicht

save(String)

Saves the node and all childs.

Methodenname	Rückgabetyp	Verfügbar seit
save(String)	void	4.0

Übersicht

save(String, boolean)

Saves this node.

Methodenname	Rückgabetyp	Verfügbar seit
save(String, boolean)	void	4.0

Übersicht

set(String, Object)

Methodenname	Rückgabetyp	Verfügbar seit
set(String, Object)	Object

Übersicht

setChangeState(int)

Sets the change state for this PackagePoolItem.

Methodenname	Rückgabetyp	Verfügbar seit
setChangeState(int)	void	3.1.172

Übersicht

setColor(Color)

Set a new color.

Methodenname	Rückgabetyp	Verfügbar seit
setColor(Color)	void	3.1.168

Übersicht

setDisplayName(Language, String)

Sets the display name (label) for the specified language.

Methodenname	Rückgabetyp	Verfügbar seit
setDisplayName(Language, String)	void	5.1.205

Übersicht

setFormData(FormData)

Sets the given formdata container of this element.

Methodenname	Rückgabetyp	Verfügbar seit
setFormData(FormData)	void	4.2.440

Übersicht

setInheritWorkflowPermission(boolean)

Sets a boolean flag to enable or disable the inheritance of workflow permissions for this StoreElement.

Methodenname	Rückgabetyp	Verfügbar seit
setInheritWorkflowPermission(boolean)	void	3.0.1

Übersicht

setLifespan(long, long)

Set the lifespan of the current section.

Methodenname	Rückgabetyp	Verfügbar seit
setLifespan(long, long)	void	3.0

Übersicht

setLock(boolean)

Lock or unlock this element and all children.

Methodenname	Rückgabetyp	Verfügbar seit
setLock(boolean)	void	2.3

Übersicht

setLock(boolean, boolean)

Lock or unlock this element, if recursive == true all children are also (un)locked.

Methodenname	Rückgabetyp	Verfügbar seit
setLock(boolean, boolean)	void	4.0.17

Übersicht

setMetaFormData(FormData)

Sets the given formdata container of this element. Removes meta data if null is provided.

Methodenname	Rückgabetyp	Verfügbar seit
setMetaFormData(FormData)	void	4.2.450

Übersicht

setName(String)

Set the name of a section

Methodenname	Rückgabetyp	Verfügbar seit
setName(String)	void	3.0

Übersicht

setPermission(Group, Permission)

Set the defined permission for the given group.

Methodenname	Rückgabetyp	Verfügbar seit
setPermission(Group, Permission)	void	2.3

Übersicht

setPermission(User, Permission)

Set the defined permission for the given user.

Methodenname	Rückgabetyp	Verfügbar seit
setPermission(User, Permission)	void	2.3

Übersicht

setPermission(User[], Permission)

Set the defined permission for several users.

Methodenname	Rückgabetyp	Verfügbar seit
setPermission(User[], Permission)	void	2.3

Übersicht

setTask(Task)

Set the given Task.

Methodenname	Rückgabetyp	Verfügbar seit
setTask(Task)	void	3.1.168

Übersicht

setTemplate(SectionTemplate)

Set the template for this section.

Methodenname	Rückgabetyp	Verfügbar seit
setTemplate(SectionTemplate)	void	4.1.25

Übersicht

setUid(String)

Sets the unique identifier.

Methodenname	Rückgabetyp	Verfügbar seit
setUid(String)	void	4.0

Übersicht

setWorkflowPermission(WorkflowPermission)

Methodenname	Rückgabetyp	Verfügbar seit
setWorkflowPermission(WorkflowPermission)	void	3.0.1

Übersicht

setWorkflowPermissions(WorkflowPermission[])

Methodenname	Rückgabetyp	Verfügbar seit
setWorkflowPermissions(WorkflowPermission[])	void	3.0.1

Übersicht

setWriteLock(boolean)

A write lock is a flag to prevent changes e.g. while a workflow is active for this element.

Methodenname	Rückgabetyp	Verfügbar seit
setWriteLock(boolean)	void	3.0.4

Übersicht

toJSON

Convert to a JSON-compatible string representation including necessary quotes and escaping for immediate use. Handles Maps, Collections, Arrays, Numbers, Strings, Boolean, Date, and JsonElement. A date instance will be converted to an ISO-8601 formatted date string. Any object other than above will be converted using its 'toString()' value.

Methodenname	Rückgabetyp	Verfügbar seit
toJSON	String	5.2.11

Übersicht

toString

Methodenname	Rückgabetyp	Verfügbar seit
toString	String

Übersicht

toXml

Creates the xml representation of the node with all children but without indentation and line breaks.

Methodenname	Rückgabetyp	Verfügbar seit
toXml	String	2.3

Übersicht

toXml(boolean)

Creates the xml representation with or without all children depending on the given parameter.

Methodenname	Rückgabetyp	Verfügbar seit
toXml(boolean)	String	4.0

Übersicht

toXml(boolean, boolean)

Creates the xml representation with or without children, line breaks and indentation depending on the given parameters.

Methodenname	Rückgabetyp	Verfügbar seit
toXml(boolean, boolean)	String	4.0

Übersicht

type

Methodenname	Rückgabetyp	Verfügbar seit
type	String

Übersicht

Druckversion | Seitenanfang