Package com.groupdocs.cloud.signature.model

Class OptionsBase

java.lang.Object

com.groupdocs.cloud.signature.model.OptionsBase

Direct Known Subclasses:

SearchOptions, SignOptions, VerifyOptions

public class OptionsBase
extends Object

Base container class for all possible options data

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OptionsBase.SignatureTypeEnum	Specifies the signature type of processing

Constructor Summary

Constructors

Constructor	Description
OptionsBase()

Method Summary

Modifier and Type	Method	Description
OptionsBase	allPages(Boolean allPages)
boolean	equals(Object o)
Boolean	getAllPages()	Process all document pages.
Integer	getPage()	Gets or sets a document page number for processing.
PagesSetup	getPagesSetup()	Options to specify pages for processing
OptionsBase.SignatureTypeEnum	getSignatureType()	Specifies the signature type of processing
int	hashCode()
OptionsBase	page(Integer page)
OptionsBase	pagesSetup(PagesSetup pagesSetup)
void	setAllPages(Boolean allPages)
void	setPage(Integer page)
void	setPagesSetup(PagesSetup pagesSetup)
void	setSignatureType(OptionsBase.SignatureTypeEnum signatureType)
OptionsBase	signatureType(OptionsBase.SignatureTypeEnum signatureType)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

OptionsBase

public OptionsBase()

Method Detail

signatureType

public OptionsBase signatureType(OptionsBase.SignatureTypeEnum signatureType)

getSignatureType

public OptionsBase.SignatureTypeEnum getSignatureType()

Specifies the signature type of processing

Returns:

signatureType

setSignatureType

public void setSignatureType(OptionsBase.SignatureTypeEnum signatureType)

page

public OptionsBase page(Integer page)

getPage

public Integer getPage()

Gets or sets a document page number for processing. Value is optional

Returns:

page

setPage

public void setPage(Integer page)

allPages

public OptionsBase allPages(Boolean allPages)

getAllPages

public Boolean getAllPages()

Process all document pages. Type of processing depends on SignatureType For Images Document Type it can be used only for multi-frames images like .tiff

Returns:

allPages

setAllPages

public void setAllPages(Boolean allPages)

pagesSetup

public OptionsBase pagesSetup(PagesSetup pagesSetup)

getPagesSetup

public PagesSetup getPagesSetup()

Options to specify pages for processing

Returns:

pagesSetup

setPagesSetup

public void setPagesSetup(PagesSetup pagesSetup)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object