SignDoc SDK (Java)  5.0.0
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
SignDocCheckSignatureParameters Class Reference

Parameters for SignDocSignatureData.checkReference() and SignDocSignatureData.checkSignature(). More...

Inheritance diagram for SignDocCheckSignatureParameters:

Public Member Functions

 SignDocCheckSignatureParameters ()
 Constructor. More...
 
synchronized SignDocCheckSignatureParameters clone () throws SignDocException
 Clone this object. More...
 
synchronized void clear () throws SignDocException
 Unset all parameters. More...
 
synchronized void setBoolean (String aName, boolean aValue) throws SignDocException
 Set a boolean parameter. More...
 
synchronized void setInteger (String aName, int aValue) throws SignDocException
 Set an integer parameter. More...
 
synchronized Boolean getBoolean (String aName) throws SignDocException
 Get the value of a boolean parameter. More...
 
synchronized Integer getInteger (String aName) throws SignDocException
 Get the value of an integer parameter. More...
 
synchronized String getErrorMessage () throws SignDocException
 Get an error message for the last function call. More...
 
synchronized void close ()
 Destroy the underlying native object (for java.lang.AutoCloseable). More...
 

Static Public Member Functions

static int getType (String aName) throws SignDocException
 Get the type of a parameter. More...
 

Static Public Attributes

static final int t_undefined = 0
 Return value of getType(): The specified parameter is not defined. More...
 
static final int t_boolean = 1
 Return value of getType(): Boolean. More...
 
static final int t_integer = 2
 Return value of getType(): Integer. More...
 

Protected Member Functions

void finalize () throws Throwable
 Finalize this object. More...
 

Detailed Description

Parameters for SignDocSignatureData.checkReference() and SignDocSignatureData.checkSignature().

Constructor & Destructor Documentation

SignDocCheckSignatureParameters ( )

Constructor.

No parameters will be set.

Member Function Documentation

synchronized void clear ( ) throws SignDocException

Unset all parameters.

After calling this function no parameters will be set.

synchronized SignDocCheckSignatureParameters clone ( ) throws SignDocException

Clone this object.

Returns
A clone of this object.
synchronized void close ( )

Destroy the underlying native object (for java.lang.AutoCloseable).

After calling this method, all methods but close() will throw SignDocUnexpectedErrorException.

void finalize ( ) throws Throwable
protected

Finalize this object.

Do not call this method unless you know what you are doing.

synchronized Boolean getBoolean ( String  aName) throws SignDocException

Get the value of a boolean parameter.

Parameters
[in]aNameThe name of the parameter (case-sensitive).
Returns
The value of the parameter or null if the parameter is not set or is not a boolean parameter.
See also
setBoolean()
synchronized String getErrorMessage ( ) throws SignDocException

Get an error message for the last function call.

Returns
A string describing the reason for the failure of the last function call. The string is empty if the last call succeeded.
synchronized Integer getInteger ( String  aName) throws SignDocException

Get the value of an integer parameter.

Parameters
[in]aNameThe name of the parameter (case-sensitive).
Returns
The value of the parameter or null if the parameter is not set or is not an integer parameter.
See also
setInteger()
static int getType ( String  aName) throws SignDocException
static

Get the type of a parameter.

Parameters
[in]aNameThe name of the parameter (case-sensitive).
Returns
The type of the parameter: t_undefined, t_boolean, or t_integer.
synchronized void setBoolean ( String  aName,
boolean  aValue 
) throws SignDocException

Set a boolean parameter.

The following boolean parameter is available for use with SignDocSignatureData.checkReference():

  • ReferenceCheckSignatures: true to check all signatures of a reference. The default value is false.

This function throws SignDocUnknownParameterException if aName is not the name of a boolean parameter.

Parameters
[in]aNameThe name of the parameter (case-sensitive).
[in]aValueThe value of the parameter.
See also
getBoolean(), setInteger()
synchronized void setInteger ( String  aName,
int  aValue 
) throws SignDocException

Set an integer parameter.

The following integer parameters are available for use with SignDocSignatureData.checkReference():

  • ReferenceMinSignatures: minimum number of signatures in a reference. Set to 0 to skip the test. The default value is 3.
  • ReferenceMinDynamicQuality (0 through 100): minimum dynamic quality of a reference (see SignDocSignatureData.getDynamicQuality()). Set to 0 to skip the test. The default value is 60.
  • ReferenceMinStaticQuality (0 through 100): minimum static quality of a reference (see SignDocSignatureData.getStaticQuality()). Set to 0 to skip the test. The default value is 80.
  • ReferenceMaxDuration: maximum reference capture duration in seconds. Set to 0 to skip the test. The default value is 600. The reference capture duration is computed by subtracting the smallest signature timestamp of the reference from the greatest signature timestamp of the reference.

The following integer parameters will be used by SignDocSignatureData.checkReference() if the value of boolean parameter "ReferenceCheckSignatures" is true and (unconditionally) by SignDocSignatureData.checkSignature():

  • SignatureMinWidth: minimum width of a signature in mm. Set to 0 to skip the test. The default value is 10.
  • SignatureMinHeight: minimum height of a signature in mm. Set to 0 to skip the test. The default value is 5.
  • SignatureMinPressureLevels (0 through 100): minimum number of different pressure levels in a signature in percent of the pressure levels provided by the capture device or 1024 (whichever is lower). Set to 0 to skip the test. The default value is 5.
  • SignatureMinComplexity (0 through 100): minimum static quality (see SignDocSignatureData.getComplexity()). Set to 0 to skip the test. The default value is 35.
  • SignatureMinSamples: minimum number of samples with positive pressure in a signature. Set to 0 to skip the test. The default value is 10.
Note
In SignWare, ReferenceMinStaticQuality is named SPReferenceMinMatch, SignatureMinSamples is named SPSignatureMinVectors, and SignatureMinComplexity is named SPSignatureMinStaticQuality.

This function throws SignDocUnknownParameterException if aName is not the name of an integer parameter, SignDocInvalidValueException if aValue is invalid.

Parameters
[in]aNameThe name of the parameter (case-sensitive).
[in]aValueThe value of the parameter.
See also
getInteger(), setBoolean()

Member Data Documentation

final int t_boolean = 1
static

Return value of getType(): Boolean.

final int t_integer = 2
static

Return value of getType(): Integer.

final int t_undefined = 0
static

Return value of getType(): The specified parameter is not defined.

The documentation for this class was generated from the following file: