Package de.elo.ix.client.esearch
Class CompletionOptions
java.lang.Object
de.elo.ix.client.esearch.ESearchOptions
de.elo.ix.client.esearch.CompletionOptions
- All Implemented Interfaces:
Serializable
Use this class if a completion should be retrieved by
Deliver text to complete in
IXServicePortIF.findCompletion(de.elo.ix.client.ClientInfo, de.elo.ix.client.FindInfo, int)
.Deliver text to complete in
ESearchParams.query
.- Since:
- 10.99.999.009
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected QueryFilter
Defines field to retrieve completion.protected FieldTypeE
Defines type (tokenized/ not tokenized) of returned values. -
Constructor Summary
ConstructorsConstructorDescriptionCompletionOptions
(QueryFilter completionField) CompletionOptions
(QueryFilter completionField, FieldTypeE returnType) -
Method Summary
Modifier and TypeMethodDescriptionvoid
setCompletionField
(QueryFilter completionField) void
setReturnType
(FieldTypeE returnType) toString()
-
Field Details
-
completionField
Defines field to retrieve completion.
Submit text to get completion for by
completionField.value
Additionally, a query and queryOperator can be added via ESearchParams.
Note: Currently, it's only possible to return completion suggestions for title and indexfields
-
returnType
Defines type (tokenized/ not tokenized) of returned values. If nullFieldTypeE.tokenized
is used as default value.
-
-
Constructor Details
-
CompletionOptions
public CompletionOptions() -
CompletionOptions
-
CompletionOptions
-
-
Method Details
-
getCompletionField
-
setCompletionField
-
getReturnType
-
setReturnType
-
toString
- Overrides:
toString
in classESearchOptions
-