Package de.elo.ix.client.esearch

Class DocumentOptions

java.lang.Object

de.elo.ix.client.esearch.ESearchOptions

de.elo.ix.client.esearch.DocumentOptions

All Implemented Interfaces:

Serializable

public class DocumentOptions
extends ESearchOptions

Use this class to search for documents by IXServicePortIF.findFirstSords(de.elo.ix.client.ClientInfo, de.elo.ix.client.FindInfo, int, de.elo.ix.client.SordZ) and IXServicePortIF.findNextSords(de.elo.ix.client.ClientInfo, String, int, int, de.elo.ix.client.SordZ).
Deliver query by ESearchParams.

Since:

10.99.999.019

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected int	currentFolderId	Provide this ID to restrict search on current folder.
protected boolean	highlightedText	Return highlighted result text for each sord. Highlighted text is retrieved from fulltext and surrounded by b-tags. Defaults to false.
protected boolean	relevance	Calculate relevance for each sord. Defaults to false.
protected boolean	resultField	Return fields in which search terms are found for each sord. Defaults to false.
protected ESearchOrderE	sort	Results are ordered by this parameter.

Constructor Summary

Constructors

Constructor	Description
DocumentOptions()

Method Summary

Modifier and Type	Method	Description
int	getCurrentFolderId()
ESearchOrderE	getSort()
boolean	isHighlightedText()
boolean	isRelevance()
boolean	isResultField()
void	setCurrentFolderId(int currentFolderId)
void	setHighlightedText(boolean highlightedText)
void	setRelevance(boolean relevance)
void	setResultField(boolean resultField)
void	setSort(ESearchOrderE sort)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

sort

protected ESearchOrderE sort

Results are ordered by this parameter.

See Also:

• ESearchOrderE

highlightedText

protected boolean highlightedText

Return highlighted result text for each sord.
Highlighted text is retrieved from fulltext and surrounded by b-tags.
Defaults to false.

resultField

protected boolean resultField

Return fields in which search terms are found for each sord.
Defaults to false.

relevance

protected boolean relevance

Calculate relevance for each sord.
Defaults to false.

currentFolderId

protected int currentFolderId

Provide this ID to restrict search on current folder.

Constructor Details

DocumentOptions

public DocumentOptions()

Method Details

getSort

public ESearchOrderE getSort()

getCurrentFolderId

public int getCurrentFolderId()

isHighlightedText

public boolean isHighlightedText()

isResultField

public boolean isResultField()

isRelevance

public boolean isRelevance()

setSort

public void setSort(ESearchOrderE sort)

setHighlightedText

public void setHighlightedText(boolean highlightedText)

setResultField

public void setResultField(boolean resultField)

setRelevance

public void setRelevance(boolean relevance)

setCurrentFolderId

public void setCurrentFolderId(int currentFolderId)

toString

public String toString()

Overrides:

toString in class ESearchOptions