Data type TargetReference

Value range of the data type DatasetContainer

FirstSpirit provides the data type TargetReference for processing values which represent a reference to a FirstSpirit object.

The data type TargetReference returns a reference to any FirstSpirit object. The type of the referenced object is not determined: references can be selected to media (pictures and files), to document groups, folders, pages (Page Store), page references (Site Store) and Content2 objects (Content Store) as well as to any other Store.

For further information about the data type TargetReference see API documentation:

de.espirit.firstspirit.access.editor.value.TargetReference

Definition using the standard input components

The input component FS_REFERENCE can be used for including references to FirstSpirit objects (page references, pages from the Page Store, media etc.).

This input component returns the data type TargetReference when accessing the stored value by means of a $CMS_VALUE(...)$ instruction.

Methods on TargetReference objects

The table below lists all methods which can be invoked on objects of data type TargetReference:

compareTo(Comparable)

Overview

equals(Object)

Overview

get

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

getContent

Overview

getDocumentGroup

Overview

getLanguage

Overview

getMedia

Overview

getPage

Overview

getPageRef

Overview

getRemoteSymName

Overview

getSection

Overview

getSectionName

Overview

getStoreType

Overview

getUid

Overview

getUidType

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 .isEmpty() 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

loadSection(Page, String)

Overview

print

Overview

resetTo(IDProvider, String)

Overview

set(IDProvider)

Overview

set(String, Object)

Overview

setRemoteSymName(String)

Overview

setSection(Section)

Overview

setSectionName(String)

Overview

setUid(String)

Overview

setUidType(IDProvider$UidType)

Overview

toJson

Overview

toString

Overview

type

Overview