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

The object is generated by the following form objects:
CMS_INPUT_PERMISSION
Method name Return type Brief description Available since
addChangeListener(ValueChangeListener) void Register a change listener. 4.0.17
equals(Object) boolean
get Element Provides the permissions definition element. 4.1.9
getActivityNames List Provides a list of names for defined activities. 4.1.9
getAllowed(String) Set Returns all allowed group IDs, if the permissions are not inherited. 4.1.9
getAllowedExplicit(String) Set Returns all explicitly allowed group paths, if the permissions are not inherited. 4.1.9
getClass Class Class of the invoking object
getForbidden(String) Set Returns all forbidden group IDs, if the permissions are not inherited. 4.1.9
getForbiddenExplicit(String) Set Returns all explicitly forbidden group paths, if the permissions are not inherited. 4.1.9
getGroupsName String Provides the name of groups. 4.1.9
getNotifier SimpleValueChangeNotifier Provides a notifier on changes within these permissions. 4.1.9
getPriority Priority Provides the priority setting for this permissions. 4.1.9
isCase(Object) boolean
isEmpty boolean Indicates that no permissions are defined. 4.1.9
isInherited boolean Indicates that permissions of this container are inherited. 4.1.9
isNull boolean Checks whether an expression is null (zero)
print void
removeChangeListener(ValueChangeListener) void Unregister a change listener. 4.0.17
set(Element) void Set the permission definition element. 4.1.9
set(String, Object) Object
setAllowed(String, Collection) void Sets the allowed groups for the given operation. 4.1.9
setConnection(Connection) void Sets the connection to be used for permissions. 4.1.9
setForbidden(String, Collection) void Sets the forbidden groups for the given operation. 4.1.9
setInherited(boolean) void Defines the permissions to be inherited. 4.1.9
setPriority(Priority) void Set the priorities for this permissions. 4.1.9
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
type String

addChangeListener(ValueChangeListener)

Register a change listener.
Method name Return type Available since
addChangeListener(ValueChangeListener) void 4.0.17

equals(Object)

Method name Return type Available since
equals(Object) boolean

get

Provides the permissions definition element.
Method name Return type Available since
get Element 4.1.9

getActivityNames

Provides a list of names for defined activities.
Method name Return type Available since
getActivityNames List 4.1.9

getAllowed(String)

Returns all allowed group IDs, if the permissions are not inherited.
Method name Return type Available since
getAllowed(String) Set 4.1.9

getAllowedExplicit(String)

Returns all explicitly allowed group paths, if the permissions are not inherited.
Method name Return type Available since
getAllowedExplicit(String) Set 4.1.9

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

getForbidden(String)

Returns all forbidden group IDs, if the permissions are not inherited.
Method name Return type Available since
getForbidden(String) Set 4.1.9

getForbiddenExplicit(String)

Returns all explicitly forbidden group paths, if the permissions are not inherited.
Method name Return type Available since
getForbiddenExplicit(String) Set 4.1.9

getGroupsName

Provides the name of groups.
Method name Return type Available since
getGroupsName String 4.1.9

getNotifier

Provides a notifier on changes within these permissions.
Method name Return type Available since
getNotifier SimpleValueChangeNotifier 4.1.9

getPriority

Provides the priority setting for this permissions.
Method name Return type Available since
getPriority Priority 4.1.9

isCase(Object)

Method name Return type Available since
isCase(Object) boolean

isEmpty

Indicates that no permissions are defined.
Method name Return type Available since
isEmpty boolean 4.1.9

isInherited

Indicates that permissions of this container are inherited.
Method name Return type Available since
isInherited boolean 4.1.9

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

print

Method name Return type Available since
print void

removeChangeListener(ValueChangeListener)

Unregister a change listener.
Method name Return type Available since
removeChangeListener(ValueChangeListener) void 4.0.17

set(Element)

Set the permission definition element.
Method name Return type Available since
set(Element) void 4.1.9

set(String, Object)

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

setAllowed(String, Collection)

Sets the allowed groups for the given operation.
Method name Return type Available since
setAllowed(String, Collection) void 4.1.9

setConnection(Connection)

Sets the connection to be used for permissions.
Method name Return type Available since
setConnection(Connection) void 4.1.9

setForbidden(String, Collection)

Sets the forbidden groups for the given operation.
Method name Return type Available since
setForbidden(String, Collection) void 4.1.9

setInherited(boolean)

Defines the permissions to be inherited.
Method name Return type Available since
setInherited(boolean) void 4.1.9

setPriority(Priority)

Set the priorities for this permissions.
Method name Return type Available since
setPriority(Priority) void 4.1.9

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

toString

Method name Return type Available since
toString String

type

Method name Return type Available since
type String

© 2005 - 2024 Crownpeak Technology GmbH | All rights reserved. | FirstSpirit 2024.7 | Data privacy