CompletionOptions (ELO IndexServer Documentation)

java.lang.Object

de.elo.ix.client.esearch.ESearchOptions

de.elo.ix.client.esearch.CompletionOptions

All Implemented Interfaces:: java.io.Serializable

public class CompletionOptions
extends ESearchOptions

Use this class if a completion should be retrieved by 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:: Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`protected QueryFilter`	`completionField`	Defines field to retrieve completion.
`protected FieldTypeE`	`returnType`	Defines type (tokenized/ not tokenized) of returned values.

Constructor Summary

Constructors
Constructor	Description
`CompletionOptions()`
`CompletionOptions(QueryFilter completionField)`
`CompletionOptions(QueryFilter completionField, FieldTypeE returnType)`

Method Summary

Modifier and Type	Method	Description
`QueryFilter`	`getCompletionField()`
`FieldTypeE`	`getReturnType()`
`void`	`setCompletionField(QueryFilter completionField)`
`void`	`setReturnType(FieldTypeE returnType)`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details
- completionField
  
  protected QueryFilter 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
  
  protected FieldTypeE returnType
  
  Defines type (tokenized/ not tokenized) of returned values.
  If null, FieldTypeC.tokenized is used as default value.
Constructor Details
- CompletionOptions
  
  public CompletionOptions()
- CompletionOptions
  
  public CompletionOptions(QueryFilter completionField)
- CompletionOptions
  
  public CompletionOptions(QueryFilter completionField, FieldTypeE returnType)
Method Details
- getCompletionField
  
  public QueryFilter getCompletionField()
- setCompletionField
  
  public void setCompletionField(QueryFilter completionField)
- getReturnType
  
  public FieldTypeE getReturnType()
- setReturnType
  
  public void setReturnType(FieldTypeE returnType)
- toString
  
  public java.lang.String toString()
  
  Overrides:
  
  toString in class ESearchOptions