WSSearchOptions (logicaldoc 6.8.3 API)

java.lang.Object
- com.logicaldoc.webservice.search.WSSearchOptions

All Implemented Interfaces:

Comparable<WSSearchOptions>
```
public class WSSearchOptions
extends Object
implements Comparable<WSSearchOptions>
```
Search options through Web Services.

Since:

6.7

Author:

Marco Meschieri - Logical Objects

Field Summary

Fields
Modifier and Type Field and Description

protected String description

protected String expression

protected int maxHits

protected String name

Fields
Modifier and Type	Field and Description
`protected String`	`description`
`protected String`	`expression`
`protected int`	`maxHits`
`protected String`	`name`

Constructor Summary

Constructors
Constructor and Description

WSSearchOptions()
Necessary constructor for the Search Web Service

Constructors
Constructor and Description
`WSSearchOptions()` Necessary constructor for the Search Web Service

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`compareTo(WSSearchOptions o)`
`static WSSearchOptions`	`fromSearchOptions(SearchOptions opt)`
`int`	`getCaseSensitive()`
`String`	`getCreationFrom()`
`String`	`getCreationTo()`
`String`	`getDateFrom()`
`String`	`getDateTo()`
`String`	`getDescription()`
`String`	`getExpression()`
`String`	`getExpressionLanguage()`
`String[]`	`getFields()`
`Long[]`	`getFilterIds()`
`Long`	`getFolderId()`
`String`	`getFormat()`
`String`	`getLanguage()`
`int`	`getMaxHits()`
`String`	`getName()`
`int`	`getRetrieveAliases()`
`Long`	`getSizeMax()`
`Long`	`getSizeMin()`
`String`	`getSourceDateFrom()`
`String`	`getSourceDateTo()`
`Long`	`getTemplate()`
`String`	`getTopOperator()`
`int`	`getType()`
`int`	`isSearchInSubPath()`
`void`	`setCaseSensitive(int caseSensitive)`
`void`	`setCreationFrom(String creationFrom)`
`void`	`setCreationTo(String creationTo)`
`void`	`setDateFrom(String dateFrom)`
`void`	`setDateTo(String dateTo)`
`void`	`setDescription(String description)`
`void`	`setExpression(String expr)`
`void`	`setExpressionLanguage(String expressionLanguage)`
`void`	`setFields(String[] fields)`
`void`	`setFilterIds(Long[] filterIds)`
`void`	`setFolderId(Long folderId)`
`void`	`setFormat(String format)`
`void`	`setLanguage(String language)`
`void`	`setMaxHits(int maxHits)`
`void`	`setName(String name)`
`void`	`setRetrieveAliases(int retrieveAliases)`
`void`	`setSearchInSubPath(int searchInSubPath)`
`void`	`setSizeMax(Long sizeMax)`
`void`	`setSizeMin(Long sizeMin)`
`void`	`setSourceDateFrom(String sourceDateFrom)`
`void`	`setSourceDateTo(String sourceDateTo)`
`void`	`setTemplate(Long template)`
`void`	`setTopOperator(String topOperator)`
`void`	`setType(int type)`
`SearchOptions`	`toSearchOptions()`

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

Field Detail

maxHits
```
protected int maxHits
```

expression
```
protected String expression
```

name
```
protected String name
```

description
```
protected String description
```

Constructor Detail
- WSSearchOptions
```
public WSSearchOptions()
```
  Necessary constructor for the Search Web Service

Method Detail

setExpression

public void setExpression(String expr)

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

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

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

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

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

setDescription

public void setDescription(String description)

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

setMaxHits
```
public void setMaxHits(int maxHits)
```

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

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

setTopOperator

public void setTopOperator(String topOperator)

getFilterIds
```
public Long[] getFilterIds()
```

setFilterIds

public void setFilterIds(Long[] filterIds)

getCaseSensitive
```
public int getCaseSensitive()
```

setCaseSensitive

public void setCaseSensitive(int caseSensitive)

getRetrieveAliases
```
public int getRetrieveAliases()
```

setRetrieveAliases

public void setRetrieveAliases(int retrieveAliases)

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

setFolderId

public void setFolderId(Long folderId)

isSearchInSubPath
```
public int isSearchInSubPath()
```

setSearchInSubPath

public void setSearchInSubPath(int searchInSubPath)

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

compareTo in interface Comparable<WSSearchOptions>

getExpressionLanguage
```
public String getExpressionLanguage()
```

setExpressionLanguage

public void setExpressionLanguage(String expressionLanguage)

getSizeMin
```
public Long getSizeMin()
```

setSizeMin
```
public void setSizeMin(Long sizeMin)
```

getSizeMax
```
public Long getSizeMax()
```

setSizeMax
```
public void setSizeMax(Long sizeMax)
```

getFormat
```
public String getFormat()
```

setFormat
```
public void setFormat(String format)
```

getFields
```
public String[] getFields()
```

setFields

public void setFields(String[] fields)

getLanguage
```
public String getLanguage()
```

setLanguage

public void setLanguage(String language)

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

setTemplate

public void setTemplate(Long template)

getDateFrom
```
public String getDateFrom()
```

setDateFrom

public void setDateFrom(String dateFrom)

getDateTo
```
public String getDateTo()
```

setDateTo
```
public void setDateTo(String dateTo)
```

getSourceDateFrom
```
public String getSourceDateFrom()
```

setSourceDateFrom

public void setSourceDateFrom(String sourceDateFrom)

getSourceDateTo
```
public String getSourceDateTo()
```

setSourceDateTo

public void setSourceDateTo(String sourceDateTo)

getCreationFrom
```
public String getCreationFrom()
```

setCreationFrom

public void setCreationFrom(String creationFrom)

getCreationTo
```
public String getCreationTo()
```

setCreationTo

public void setCreationTo(String creationTo)

fromSearchOptions

public static WSSearchOptions fromSearchOptions(SearchOptions opt)

toSearchOptions

public SearchOptions toSearchOptions()

Class WSSearchOptions

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

maxHits

expression

name

description

Constructor Detail

WSSearchOptions

Method Detail

setExpression

getType

setType

getName

setName

getDescription

setDescription

getMaxHits

setMaxHits

getExpression

getTopOperator

setTopOperator

getFilterIds

setFilterIds

getCaseSensitive

setCaseSensitive

getRetrieveAliases

setRetrieveAliases

getFolderId

setFolderId

isSearchInSubPath

setSearchInSubPath

compareTo

getExpressionLanguage

setExpressionLanguage

getSizeMin

setSizeMin

getSizeMax

setSizeMax

getFormat

setFormat

getFields

setFields

getLanguage

setLanguage

getTemplate

setTemplate

getDateFrom

setDateFrom

getDateTo

setDateTo

getSourceDateFrom

setSourceDateFrom

getSourceDateTo

setSourceDateTo

getCreationFrom

setCreationFrom

getCreationTo

setCreationTo

fromSearchOptions

toSearchOptions