java.lang.Object
- com.logicaldoc.core.searchengine.SearchOptions

All Implemented Interfaces:

Serializable, Comparable<SearchOptions>

Direct Known Subclasses:

FolderSearchOptions, FulltextSearchOptions
```
public class SearchOptions
extends Object
implements Serializable, Comparable<SearchOptions>
```
Search options

Author:

Michael Scholz

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

static int TYPE_FOLDERS

static int TYPE_FULLTEXT

static int TYPE_PARAMETRIC

static int TYPE_TAG

Constructor Summary

Constructors
Constructor Description

SearchOptions(int type)
Creates a new instance of SearchOptions

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`compareTo(SearchOptions o)`
`String`	`getDescription()`
`String`	`getExpression()`
`Set<Long>`	`getFilterIds()`
`Long`	`getFolderId()`
`int`	`getMaxHits()`
`String`	`getName()`
`int`	`getPage()`
`Serializable[]`	`getParameters()`
`Long`	`getTemplate()`
`Long`	`getTenantId()`
`String`	`getTopOperator()`
`int`	`getType()`
`long`	`getUserId()`
`boolean`	`isCaseSensitive()`
`boolean`	`isFulltext()`
`boolean`	`isRetrieveAliases()`
`boolean`	`isSearchInSubPath()`
`static SearchOptions`	`read(File file)`
`void`	`setCaseSensitive(boolean caseSensitive)`
`void`	`setDescription(String description)`
`void`	`setExpression(String expr)`
`void`	`setFilterIds(Set<Long> filterIds)`
`void`	`setFolderId(Long folderId)`
`void`	`setMaxHits(int maxHits)`
`void`	`setName(String name)`
`void`	`setPage(int page)`
`void`	`setParameters(Serializable[] parameters)`
`void`	`setRetrieveAliases(boolean retrieveAliases)`
`void`	`setSearchInSubPath(boolean searchInSubPath)`
`void`	`setTemplate(Long template)`
`void`	`setTenantId(Long tenantId)`
`void`	`setTopOperator(String topOperator)`
`void`	`setType(int type)`
`void`	`setUserId(long userId)`
`void`	`write(File file)`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- TYPE_FULLTEXT
```
public static final int TYPE_FULLTEXT
```
  See Also:
  
  Constant Field Values
- TYPE_TAG
```
public static final int TYPE_TAG
```
  See Also:
  
  Constant Field Values
- TYPE_PARAMETRIC
```
public static final int TYPE_PARAMETRIC
```
  See Also:
  
  Constant Field Values
- TYPE_FOLDERS
```
public static final int TYPE_FOLDERS
```
  See Also:
  
  Constant Field Values

Constructor Detail
- SearchOptions
```
public SearchOptions(int type)
```
  Creates a new instance of SearchOptions
  
  Parameters:
  
  type - the type of search

Method Detail

getTemplate
```
public Long getTemplate()
```

setTemplate

public void setTemplate(Long template)

getParameters
```
public Serializable[] getParameters()
```

setParameters

public void setParameters(Serializable[] parameters)

setExpression

public void setExpression(String expr)

getType
```
public int getType()
```

setType
```
public void setType(int type)
```

read

public static SearchOptions read(File file)
                          throws FileNotFoundException,
                                 IOException,
                                 ClassNotFoundException

Throws:: FileNotFoundException; IOException; ClassNotFoundException

write

public void write(File file)
           throws FileNotFoundException,
                  IOException

Throws:: FileNotFoundException; IOException

getName
```
public String getName()
```

setName
```
public void setName(String name)
```

getDescription
```
public String getDescription()
```

setDescription

public void setDescription(String description)

compareTo
```
public int compareTo(SearchOptions o)
```
Specified by:

compareTo in interface Comparable<SearchOptions>

getMaxHits
```
public int getMaxHits()
```

setMaxHits

public void setMaxHits(int maxHits)

isFulltext
```
public boolean isFulltext()
```

getExpression
```
public String getExpression()
```

getUserId
```
public long getUserId()
```

setUserId

public void setUserId(long userId)

getTopOperator
```
public String getTopOperator()
```

setTopOperator

public void setTopOperator(String topOperator)

getFilterIds
```
public Set<Long> getFilterIds()
```

setFilterIds

public void setFilterIds(Set<Long> filterIds)

isCaseSensitive
```
public boolean isCaseSensitive()
```

setCaseSensitive

public void setCaseSensitive(boolean caseSensitive)

getFolderId
```
public Long getFolderId()
```

setFolderId

public void setFolderId(Long folderId)

isSearchInSubPath
```
public boolean isSearchInSubPath()
```

setSearchInSubPath

public void setSearchInSubPath(boolean searchInSubPath)

getTenantId
```
public Long getTenantId()
```

setTenantId

public void setTenantId(Long tenantId)

isRetrieveAliases
```
public boolean isRetrieveAliases()
```

setRetrieveAliases

public void setRetrieveAliases(boolean retrieveAliases)

getPage
```
public int getPage()
```

setPage
```
public void setPage(int page)
```

Modifier and Type	Field	Description
`static int`	`TYPE_FOLDERS`
`static int`	`TYPE_FULLTEXT`
`static int`	`TYPE_PARAMETRIC`
`static int`	`TYPE_TAG`

Class SearchOptions

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TYPE_FULLTEXT

TYPE_TAG

TYPE_PARAMETRIC

TYPE_FOLDERS

Constructor Detail

SearchOptions

Method Detail

getTemplate

setTemplate

getParameters

setParameters

setExpression

getType

setType

read

write

getName

setName

getDescription

setDescription

compareTo

getMaxHits

setMaxHits

isFulltext

getExpression

getUserId

setUserId

getTopOperator

setTopOperator

getFilterIds

setFilterIds

isCaseSensitive

setCaseSensitive

getFolderId

setFolderId

isSearchInSubPath

setSearchInSubPath

getTenantId

setTenantId

isRetrieveAliases

setRetrieveAliases

getPage

setPage