Entity data type

Value range of the Entity data type

Data records (content) can be maintained in the tables of the Content Store. These data records can be output and further processed in FirstSpirit. In addition, there are several input components in which one or several data records can be selected.

A data record is represented by the Entity data type. On the one hand the data record includes the individual columns with their values and on the other meta information, e.g. the last editor.

For further information on the Entity data type, see API documentation: de.espirit.firstspirit.access.or.schema.Entity

Methods on Entity objects

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

clear

Overview

compareTo(Comparable)

Overview

containsKey(Object)

Overview

containsValue(Object)

Overview

copy

Overview

copyFrom(Entity)

Overview

entrySet

Overview

equals(Object)

Overview

get(Set)

Overview

get(Collection)

Overview

get(String)

Overview

get(Object)

Overview

get(String, String)

Overview

getAttributeNames

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

Overview

getEditor

The .getEditor() returns the last user of the content store data. The returned User object can be used to output information about the user, e.g. abbreviation, name, etc.

Overview

getEntityType

Overview

getGid

Overview

getId

Overview

getIdentifier

Overview

getKeyValue

Overview

getLastChange

Overview

getList(String)

Overview

getReleasedBy

Overview

getSession

Overview

getState

Overview

getValue(String)

Overview

getValue(Attribute)

Overview

hashCode

Overview

isCase(Object)

Overview

isEmpty

The .isEmpty() (in Bean syntax: .isEmpty) method checks whether an expression or object is empty, e.g. storeElement.isEmpty(). The result of the semantic check depends on the expression or object, e.g. a character string is empty if it does not contain any characters. In the case of objects with complex values or objects the object decides when it is empty. 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 returns a Boolean value as the check result. true is the check result if the expression or object is empty and false if not.

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.

Overview

isReleased

Overview

isValid

Overview

keySet

Overview

print

Overview

put(Object, Object)

Overview

putAll(Map)

Overview

refresh

Overview

remove(Object)

Overview

rollback

Overview

rollbackWithRelations

Overview

set(String, Object)

Overview

set(Object, Object)

Overview

setValue(String, Object)

Overview

setValue(Attribute, Object)

Overview

size

The .size() (in Bean syntax: .size) method returns the number of the key/value pair in a map.

The returned object is an integer (see java.lang.Integer).

Overview

toJson

Overview

toString

Overview

type

Overview

values

Overview