Verfügbar für: Content Management Server, Template Engine
Aufgabe: sucht nach allen IDs von Dateien, die die angegebenen Suchkriterien erfüllen. Dabei werden jedoch nur Dateien ausgegeben, für die der Benutzer das Leserecht hat.
Zusatzinformationen: Der Befehl liefert keine impliziten (automatisch vom System erzeugten) Spiegeldateien.
Syntax:
obj where {parameter value}
Funktionsparameter:
parameter
spezifiziert die Suchkriterien
oder schränkt die Trefferliste anderweitig ein. Wird
parameter
nicht angegeben, so werden alle
Datei-IDs zurückgegeben. Die folgenden Parameter sind verfügbar:
ids
ist eine Liste von Datei-IDs. Ist der Parameter
angegeben, werden nur die Dateien mit den IDs in der als
value
angegebenen Liste durchsucht.
maxResults
gibt die höchstens zurückzugebende Anzahl Treffer
an. Der Wert 0 (Voreinstellung) deaktiviert diese Begrenzung. Siehe auch den
Systemkonfigurationseintrag maxSearchResultSize
. Der Wert dieses
Eintrags wird höher priorisiert als der Wert von maxResults
.
condition
: value
ist eine Bedingung, die eine Datei erfüllen muss, um in die
Ergebnisliste aufgenommen zu werden. value
ist eine Liste mit drei Elementen, die die zu vergleichende
Eigenschaft, den Vergleichsoperator sowie den Wert, mit dem
verglichen werden soll, enthält (in dieser Reihenfolge). Die
folgende Tabelle enthält alle Kombinationen dieser drei
Bestandteile:
Eigenschaft | Operator | Vergleichswert |
---|---|---|
name |
is |
Zeichenkette |
objType |
is |
document
Liste mit Dateitypen (siehe is ) |
state |
is |
edited Liste mit Workflowzuständen (siehe is ) |
object |
is |
inactive (ab Version 6.5.0) |
Es können mehrere Bedingungen angegeben werden, die dann implizit mit UND verknüpft werden:
obj where condition {name contains foo} \ condition {objType isOneOf {document publication}}
Wird bei objType isOneOf
oder state isOneOf
eine leere Liste angegeben, so ist die Treffermenge leer.
state isNot
ist die einzige Negation. Diese ist
erforderlich, weil Workflowzustände nicht exklusiv sind (eine Datei kann sowohl
editiert oder eingereicht als auch freigegeben sein).
Bei object is inactive
enthält die Treffermenge alle Dateien ohne bzw. ohne
zeitlich gültige Version.
Die obj where
-Bedingungen können auch in der Template
Engine verwendet werden. Allerdings gibt es dort nur freigegebene Dateien,
weshalb state
dort das Folgende liefert:
state is
/ isOneOf
...
released:
die Bedingung wird ignoriertcommitted
/ edited
: die Treffermenge ist immer leerstate isNot
...
released
: die Treffermenge ist immer leercommitted
/ edited
: die Bedingung wird ignoriertDie Eigenschaft object
kann in der
Template Engine nicht verwendet werden.
value
enthält den Wert zum entsprechenden Parameter.
Rückgabewert bei Erfolg: die Liste der IDs der passenden Dateien (stringlist).
Erforderliche Rechte (nur CM): keine Einschränkungen.
Beispiele:
CM>obj where condition {state isOneOf {edited committed}} CM>obj where ids {2001 3002} condition {name contains foo} CM>obj where condition {name is bar} condition {title contains foo} CM>obj where condition {name is foo} maxResults 20