QueryInformation (Objekt): Unterschied zwischen den Versionen

Aus SiteparkWiki
Zur Navigation springen Zur Suche springen
K (hat „QueryInformation“ nach „QueryInformation (Objekt)“ verschoben)
 
(10 dazwischenliegende Versionen von 6 Benutzern werden nicht angezeigt)
Zeile 3: Zeile 3:
  
 
==Beschreibung==
 
==Beschreibung==
Ein QueryInformation-Objekt beinhaltet eine Suchabfrage. Suchabfragen sind Statements nach den Regeln der [[SPQL]], die eine Liste von Elementen liefern. Mit Hilfe von <code>sp:collection</code> wird eine Suchabfrage ausgeführt und als Collection zurück geliefert.
+
Ein QueryInformation-Objekt beinhaltet eine Suchabfrage. Suchabfragen sind Statements nach den Regeln der [[SPQL]], die eine Liste von Elementen liefern. Über das <code>object</code>-Attribut von [[sp:collection]] kann dieses Objekt übergeben werden, um die Suchabfrage auszuführen und das Ergebnis weiter zu bearbeiten.
  
 
==Attribute==
 
==Attribute==
{| class="prettytable"
+
{| class="prettytable sortable"
 
|- class="hintergrundfarbe1"
 
|- class="hintergrundfarbe1"
 
! Attribut || Type || Beschreibung || ab IES Version
 
! Attribut || Type || Beschreibung || ab IES Version
Zeile 16: Zeile 16:
 
|-
 
|-
 
| field
 
| field
| [[Variable]]
+
| [[String]]
 
| Variablenname des Objektes
 
| Variablenname des Objektes
 
| 1
 
| 1
 +
|-
 +
| lastField
 +
| [[String]]
 +
| Variablenname des Objektes ohne Struktur-Date
 +
| 2.13
 
|-
 
|-
 
| root
 
| root
 
| [[Element]]
 
| [[Element]]
 
| Root-Element dieser Information
 
| Root-Element dieser Information
 +
| 1
 +
|-
 +
| parent
 +
| [[ID]]
 +
| ID des Objektes, in dem diese Information eingebettet ist. Dies kann ein [[Element]], eine [[SubInformation]] oder eine [[ListItemInformation]] sein
 
| 1
 
| 1
 
|-
 
|-
Zeile 36: Zeile 46:
 
|-
 
|-
 
| query
 
| query
| [[Query]]
+
| [[SPQL]]
 
| Suchabfrage
 
| Suchabfrage
 
| 1
 
| 1
Zeile 51: Zeile 61:
 
|}
 
|}
  
 +
==Methoden==
 +
{| class="prettytable sortable"
 +
|- class="hintergrundfarbe1"
 +
! Methode || Rückgabewert || Beschreibung || ab IES Version
 +
|-
 +
| <code>toXip([[Boolean]] emptyFields)</code>
 +
| String
 +
| Erzeugt XML-Daten im XIP-Format für dieses Objekt
 +
| 2.14
 +
|}
 +
 +
;<code>[[String]] toXip([[Boolean]] emptyFields)</code>
 +
:Erzeugt XML-Daten im XIP-Format für dieses Objekt.
 +
:;Parameter
 +
::;<code>Boolean emptyFields</code>
 +
:::Gibt an, ob auch leere Felder enthalten sein sollen (Default ist true).
 +
:;Rückgabewert
 +
::;String
 +
:::XML-Daten im XIP-Format
 
<noinclude>
 
<noinclude>
 
[[Category:Objekte]]
 
[[Category:Objekte]]
[[Category:Qualität_des_Inhalts_prüfen]]
 
[[Category:Qualität_der_Sprache_prüfen]]
 
 
[[Category:Qualität_des_Codes_prüfen]]
 
[[Category:Qualität_des_Codes_prüfen]]
 
</noinclude>
 
</noinclude>

Aktuelle Version vom 4. November 2015, 13:14 Uhr

Name

QueryInformation - Suchabfrage

Beschreibung

Ein QueryInformation-Objekt beinhaltet eine Suchabfrage. Suchabfragen sind Statements nach den Regeln der SPQL, die eine Liste von Elementen liefern. Über das object-Attribut von sp:collection kann dieses Objekt übergeben werden, um die Suchabfrage auszuführen und das Ergebnis weiter zu bearbeiten.

Attribute

Attribut Type Beschreibung ab IES Version
id ID ID des Objektes 1
field String Variablenname des Objektes 1
lastField String Variablenname des Objektes ohne Struktur-Date 2.13
root Element Root-Element dieser Information 1
parent ID ID des Objektes, in dem diese Information eingebettet ist. Dies kann ein Element, eine SubInformation oder eine ListItemInformation sein 1
locale Locale Sprache, für die die Information gilt 1
isEmpty Boolean true, wenn keine Suchabfrage angegeben ist. 1
query SPQL Suchabfrage 1
hasError Boolean true, wenn die Suchabfrage syntaktische Fehler enthält 1
error String Fehlerbeschreibung 1

Methoden

Methode Rückgabewert Beschreibung ab IES Version
toXip(Boolean emptyFields) String Erzeugt XML-Daten im XIP-Format für dieses Objekt 2.14
String toXip(Boolean emptyFields)
Erzeugt XML-Daten im XIP-Format für dieses Objekt.
Parameter
Boolean emptyFields
Gibt an, ob auch leere Felder enthalten sein sollen (Default ist true).
Rückgabewert
String
XML-Daten im XIP-Format