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