obj search

Verfügbar für: Content Management Server

Aufgabe: Das Kommando sucht unter Verwendung des Search Engine Servers nach Dateien, die auf die übergebene Suchanfrage passen.

Syntax:

obj search {parameter value}

Funktionsparameter:

• parameter spezifiziert den Namen eines Parameters, dessen Wert als value übergeben wird. parameter kann sein:

  • query: Gibt an, dass value eine Suchanfrage in der Syntax der installierten Suchmaschine ist. Die Suchanfrage wird weder vom Content Manager noch vom Search Engine Server auf syntaktische Richtigkeit überprüft. Dieser Parameter ist obligatorisch.

  • minRelevance (optional): value gibt die minimale Relevanz an, die auf die Suchanfrage passende Dateien haben müssen, um in die Trefferliste aufgenommen zu werden. Der Wert von value muss eine ganze Zahl zwischen 0 und 100 (jeweils einschließlich) sein, wobei 0 die niedrigste und 100 die größte mögliche Relevanz ist.

  • maxDocs (optional): Gibt an, dass value die maximale Anzahl (positive ganze Zahl) der zurückzugebenden Treffer ist.

  • offsetStart (optional): Gibt an, dass value der Index der ersten vom Search Engine Server zu liefernden Versions-ID ist. value muss eine ganze Zahl sein. Der Index der ersten Version im Suchergebnis ist 1.

  • offsetLength (optional): Gibt an, dass value die Anzahl der vom Search Engine Server zu liefernden Versions-IDs enthält. value muss eine positive ganze Zahl enthalten.

  • parser (optional): Gibt an, dass value den Parser bezeichnet, mit dem Suchanfragen von der Suchmaschine bearbeitet werden sollen. Erlaubte Werte sind explicit, freetext und simple (Voreinstellung). Informationen über die Parser erhalten Sie im Handbuch Die Verity Search Cartridge.

  • collections (optional): Gibt an, dass value eine Liste der Collections enthält, auf die die Suche angewendet werden soll. Ist der Parameter nicht angegeben, so werden alle Collections durchsucht.

  • returnOption (optional): Gibt an, dass value die Art des Rückgabewertes bezeichnet. value kann sein:

    objects (Voreinstellung): Es wird eine Liste von Datei-IDs geliefert. Jede ID fasst die von der Suchmaschine gefundenen Versionen zusammen;

    includeContents: Es wird eine Liste von Listen geliefert. Jede Subliste enthält als erstes Element die Datei-ID und als weitere Elemente die IDs der Versionen dieser Datei, die auf die Suchanfrage passen.

    statistics: Es wird eine Liste mit vier Elementen geliefert, die folgendes enthält: hits Anzahl_Treffer searched Anzahl_durchsuchter_Contents.

• value ist der Wert des jeweiligen Parameters.

Rückgabewert bei Erfolg: Eine Liste, deren Inhalt vom Wert von returnOption abhängt (siehe oben).

Erforderliche Rechte (nur CM): keine Einschränkungen.

Zusatzinformationen:

• Der Search Engine Server liefert stets Versions-IDs, die von diesem Kommando voreingestellt zu Datei-IDs zusammengefasst werden.

• Die Werte von maxDocs, offsetStart und offsetLength beziehen sich auf die Versionen, die vom Search Engine Server im Suchergebnis geliefert werden, und nicht auf die Ergebnisse, die dieses Kommando liefert.

• Das Kommando gibt nur Dateien zurück, auf die der Benutzer lesend zugreifen darf.

Beispiel:

CM>obj search query {aktie <#AND> option} returnOption includeContents

{2073 3044.13 21429.9} {4982 6683.1}