Search2

Search2
MAIN
Rückgabewert
GridStruct	RET	GridStruct
Parameterliste
index	IN	RegularStringWithSingleContent
startingAt	IN	RegularNumericValue
searchExpression	IN	LongStringWithSearchContent
sortedBy	IN	LongStringWithOptionalMultiContent
resultAmount	IN	RegularNumericValue
visibility	IN	Boolean
filteredWith	IN	LongString
resultAttributes	IN	LongStringWithOptionalMultiContent

Kurzbeschreibung:

Dieser Service gibt die Business-Objekte eines bestimmten Index, welche der Search-Expression genügen, zurück. Die Treffer werden, sofern nichts anderes angegeben wird, absteigend nach Score ausgegeben.

Bemerkungen:

Gesucht wird nur in dem Mandanten, der via Kontext mitgegeben wird.

Ist resultAmount nicht angegeben, so werden fix maximal 1000 (DefaultResponseRows) Datensätze retourniert, ansonsten wird die Eingabe gegen 1‘000‘000, also die Obergrenze des Parameter-Datentyps, validiert.

VD: <siehe Validator-Fehler>

(1): System.ServiceBus.GeneralServerError

(2): Search.IndexRepoActualizationFailed

(3): Search.FilteredWithSyntaxFailure

(4): Search.NoIndexRepoEntryForIndexName

(5): Search.NoActRdyIndexForIndexName

(6): Search.NoIndexDefHelperForIndexName

(7): Search.AttributeNotAvailable

(8): Search.AttributeNotSortable

(9): Search.AttributeNotFilterable

(10): Search.AttributeNotAccessible

(11): Search.InvalidSearchExpression

(12): Search.Search2Failed

Erläuterungen:

(1) = Unerwarteter Fehler mit Beschreibung 
(2) = IndexRepository-Aktualisierung fehlgeschlagen 
(3) = Der Filter-Ausdruck ist ungültig 
(4) = Kein IndexRepository-Eintrag diesen Index 
(5) = Kein verfügbarer Index mit diesem Namen 
(6) = Der IndexDefinitionHelper ist nicht verfügbar 
(07) = Das Attribut steht nicht zur Verfügung 
(08) = Das Attribut ist kein Sortier-Attribut
(09) = Das Attribut ist kein Filter-Attribut
(10) = Das Attribut ist kein Rückgabe-Attribut
(11) = Ungültiger Suchausdruck
(12) = Fehler bei der eigentlichen Suche

Notiz

Index

Ein Index, der physikalisch zur Verfügung stehen muss.
startingAt

Der Startwert 1 (auch 0 ist hier erlaubt) bedeutet: ab dem ersten Datensatz.
searchExpression

In der searchExpression können Wildcards verwendet und einzelne Suchausdrücke mit AND (Default) und OR verknüpft werden.
sortedBy

Bei diesem Parameter können mehrere Attribute des Index durch Komma getrennt (Bsp: Attr1, Attr2 desc) angegeben werden, vorausgesetzt sie wurden vorgängig als sortierbar definiert. Die gültigen Sortierrichtungen sind asc, ascending (Default) wie auch desc, descending (String-Sortierung nach en-US, CaseSensitive). Ohne Angabe der Sortierung werden die Treffer (Lucene interner Standard) nach Score sortiert. Sobald beim Aufruf eine eigene Sortierung angegeben wird, wird der Score nicht berechnet und erscheint als "n. def." im Resultat. Der Score als Sortier-Attirbut ist nicht erlaubt, da im Falle einer eigenen Sortierung lediglich physikalisch vorhandene Spalten (die in der Konfiguration als IsSortable markiert sind) verwendet werden können.
resultAmount

Dieser Parameter gibt an, wieviele Datensätze retourniert werden sollen.
filteredWith

Die Filterung kann auf allen Spalten erfolgen, welche vorgängig als filterbar definiert wurden. Gefiltert wird in aller Regel über eine Kombination von Ausdrücken der Art (Spalte Operator Wert). Die String-Filterung erfolgt normalerweise Case-Insensitiv. Case-Sensitiv gefiltert werden kann über spezielle Operatoren.
resultAttributes

Es können alle Attribute angegeben werden, welche vorgängig als Rückgabe-Attribute definiert worden sind. Ohne Angabe von resultAttributes wird lediglich die Spalte BOID retourniert. Der * retourniert alle definierten Rückgabe-Attribute. Das Rückgabe-Attribut Score ist zulässig. Dieses wird jedoch durch Lucene nur ermittelt, wenn keine eigene Sortierung angegeben wird, ansonsten wird "n. def." retourniert. Im DebugMode können der Inhalt von SeachContent und der Inhalt der als IsSearchable markierten Spalten angefragt werden.

Services

Search2

Notiz