Parameterelemente für Feldergruppen

Mit Hilfe von Funktionselementen kann auf Feldergruppen zugegriffen werden. So kann man beispielsweise mit dem attributeGroup-get-Element die Werte sämtlicher Feldergruppen-Parameter ermitteln. Um zu spezifizieren, welche Feldergruppeneigenschaften ausgelesen oder gesetzt werden sollen, verwendet man jedoch Parameterelemente. Es gibt folgende Parameterelemente für Feldergruppen:

attributes
Bedeutung: Die Namen der Felder, die die Feldergruppe enthält. Die Namen werden in der Reihenfolge zurückgegeben, in der die Felder der Gruppe zugeordnet sind.

Definition:

<!ENTITY % cm.atom "#PCDATA">
<!ELEMENT attributes ((attribute)* | (listitem)* | (dictitem)+)>
<!ELEMENT attribute (%cm.atom; | %cm.attribute-get;)*>
<!ELEMENT listitem (%cm.atom; | listitem | dictitem)*>
<!ELEMENT dictitem (key, value)>
<!ELEMENT key (%cm.atom;)>
<!ELEMENT value (%cm.atom; | listitem | dictitem)*>

cm.attribute-get: siehe <attribute-where> <attribute-get> oder CRUL als DTD.

displayTitle
Bedeutung: Der in der HTML-Benutzerschnittstelle angezeigte Titel der Feldergruppe (eine Kombination aus Titel und Namen).

Definition:

<!ELEMENT displayTitle (%cm.atom;)>
getKeys
Bedeutung: Liste der mit attributeGroup-get abfragbaren Parameter.

Definition:

<!ELEMENT getKeys (listitem)*>
<!ELEMENT listitem (%cm.atom; | listitem | dictitem)*>
<!ELEMENT dictitem (key, value)>
<!ELEMENT key (%cm.atom;)>
<!ELEMENT value (%cm.atom; | listitem | dictitem)*>
index
Bedeutung: Der Index der Gruppe in der Feldgruppenliste der Dateivorlage. Die erste Gruppe hat den Index 0.

Definition:

<!ELEMENT index (%cm.atom;)>
isDefaultGroup
Bedeutung: Liefert 1, wenn die Gruppe die Basisgruppe ist, ansonsten 0.

Definition:

<!ELEMENT isDefaultGroup (%cm.atom;)>
isEmpty
Bedeutung: Liefert 1, wenn die Gruppe keine Felder enthält, ansonsten 0.

Definition:

<!ELEMENT isEmpty (%cm.atom;)>
localizedTitle
Bedeutung: Der lokalisierte Titel in der Sprache, die der authentifizierte Benutzer eingestellt hat. Ist dieser Titel nicht belegt, so wird title zurückgegeben, wenn title nicht ebenfalls leer ist. Andernfalls wird der Name der Feldergruppe zurückgegeben.

Definition:

<!ELEMENT localizedTitle (%cm.atom;)>
name
Bedeutung: Der Name der Feldergruppe.

Definition:

<!ELEMENT name (%cm.atom;)>
objClass
Bedeutung: Der Name der Vorlage, zu der die Feldgruppe gehört.

Definition:

<!ELEMENT objClass (%cm.atom; | %cm.objClass-get;)*>

cm.objClass-get: siehe <objClass-where> <objClass-get> oder CRUL als DTD.

setKeys
Bedeutung: Liste der mit attributeGroup-set setzbaren Parameter.

Definition:

<!ELEMENT setKeys (listitem)*>
<!ELEMENT listitem (%cm.atom; | listitem | dictitem)*>
<!ELEMENT dictitem (key, value)>
<!ELEMENT key (%cm.atom;)>
<!ELEMENT value (%cm.atom; | listitem | dictitem)*>
title
Bedeutung: Der Titel der Feldergruppe.

Definition:

<!ELEMENT title (%cm.atom;)>
<!ATTLIST title
          lang (en | de | it | fr | es) #IMPLIED
>

Bedeutung der Attribute:

  • lang: Kennzeichnet die Sprache eines Feldergruppentitels. Zu Dimensionen von Werten im CMS siehe Dimensionen von Werten.

Beispiel:

<cm-request...>
  <attributeGroup-where>
    <name>furniture</name>
  </attributeGroup-where>
  <attributeGroup-get>
    <title lang="en"/>
  </attributeGroup-get>
</cm-request>
 
<cm-response...>
  <cm-code numeric="0" phrase="ok">
    <attributeGroup>
      <title lang="en">chairs and tables</title>
    </attributeGroup>
  </cm-code>
</cm-response>