public abstract class SearchOptions extends Object
Represents the extract signatures from document options.
Modifier | Constructor and Description |
---|---|
protected |
SearchOptions(int searchType)
Initializes a new instance of the ExtractOptions class.
|
Modifier and Type | Method and Description |
---|---|
boolean |
getAllPages()
Flag to search on each Document page.
|
Integer |
getPageNumber()
Gets or sets Document page number for searching.
|
PagesSetup |
getPagesSetup()
Options to specify pages for Signature searching.
|
boolean |
getSkipExternal()
Flag to return only signatures marked as IsSignature.
|
void |
setAllPages(boolean value)
Flag to search on each Document page.
|
void |
setPageNumber(Integer value)
Gets or sets Document page number for searching.
|
void |
setPagesSetup(PagesSetup value)
Options to specify pages for Signature searching.
|
void |
setSkipExternal(boolean value)
Flag to return only signatures marked as IsSignature.
|
String |
toString()
Override string conversion.
|
protected SearchOptions(int searchType)
Initializes a new instance of the ExtractOptions class.
public final boolean getAllPages()
Flag to search on each Document page. By default this value is set to true.
public final Integer getPageNumber()
Gets or sets Document page number for searching. Value is optional.
public final PagesSetup getPagesSetup()
Options to specify pages for Signature searching.
public final boolean getSkipExternal()
Flag to return only signatures marked as IsSignature. By default value is false that indicates to return all signatures that match specified criteria.
public final void setAllPages(boolean value)
Flag to search on each Document page. By default this value is set to true.
public final void setPageNumber(Integer value)
Gets or sets Document page number for searching. Value is optional.
public final void setPagesSetup(PagesSetup value)
Options to specify pages for Signature searching.
public final void setSkipExternal(boolean value)
Flag to return only signatures marked as IsSignature. By default value is false that indicates to return all signatures that match specified criteria.