<userAttribute-where>

Ausschnitt aus der DTD:

<!ENTITY % cm.cm-request "
  ...
  (userAttribute-where+, userAttribute-addEnumValues) |
  (userAttribute-where+, userAttribute-delete) | 
  (userAttribute-where+, userAttribute-description) | 
  (userAttribute-where+, userAttribute-get) | 
  (userAttribute-where+, userAttribute-removeEnumValues) |
  (userAttribute-where+, userAttribute-set) |
  ...
">

Definition:

<!ENTITY % cm.userAttribute-where "
  (name |
  (nameLike?, 
  type?))?
">
<!ELEMENT userAttribute-where %cm.userAttribute-where;>

Aufgabe: userAttribute-where ermöglicht die Suche nach Benutzerfeldern, bei denen der Wert der angegebenen Parameter den jeweils spezifizierten String enthält. Werden keine Parameter angegeben, so werden die Namen sämtlicher Benutzerfelder zurückgegeben.

Spezielle Parameter dieses Funktionselements:

  • nameLike: bewirkt, dass die Namen der Benutzerfelder zurückgegeben werden, bei denen die angegebene Zeichenkette im Namen enthalten ist.

Verwendung: userAttribute-where ist ein Funktionselement, das nicht ohne ein weiteres unmittelbar darauf folgendes Funktionselement verwendet werden kann. Mit userAttribute-where erhält man die Liste der Namen der Benutzerfelder, die dem Suchkriterium entsprechen. Erst durch das folgende Funktionselement wird jedoch bestimmt, wie diese Benutzerfelder zu behandeln sind. Jedes der Elemente, die auf userAttribute-where folgen können, entspricht dabei einer Schablone, die nacheinander auf jedes der mit userAttribute-where ermittelten Benutzerfelder angewendet wird (siehe Requests als Schablonen und die Darstellung der Ergebnis-Daten).

Rückgabewert bei Erfolg: die Liste der Namen der Benutzerfelder.

Erforderliche Rechte: keine Einschränkungen.