visit Kofax web site

de.softpro.signware.SPTemplateOption Class Reference

List of all members.

Detailed Description

Represent a Signware template option.

Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)


Public Member Functions

byte getByte () throws SPSignwareException
 Query the value of this object.
int getInt () throws SPSignwareException
 Query the value of this object.
short getShort () throws SPSignwareException
 Query the value of this object.
String getString () throws SPSignwareException
 Query the value of this object.
int getType () throws SPSignwareException
 SPTemplateOption (byte bValue)
 SPTemplateOption (short sValue)
 SPTemplateOption (int iValue)
 SPTemplateOption (String strValue)

Package Functions

 SPTemplateOption (int iType, ParWrapper option) throws SPSignwareException


Constructor & Destructor Documentation

de.softpro.signware.SPTemplateOption.SPTemplateOption String  strValue  ) 
 

Create a new SignWare template option that represents a string

Parameters:
strValue [i] the string
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)

de.softpro.signware.SPTemplateOption.SPTemplateOption int  iValue  ) 
 

Create a new SignWare template option that represents an int

Parameters:
iValue [i] the value
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)

de.softpro.signware.SPTemplateOption.SPTemplateOption short  sValue  ) 
 

Create a new SignWare template option that represents a short

Parameters:
sValue [i] the value
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)

de.softpro.signware.SPTemplateOption.SPTemplateOption byte  bValue  ) 
 

Create a new SignWare template option that represents a byte

Parameters:
bValue [i] the value
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)

de.softpro.signware.SPTemplateOption.SPTemplateOption int  iType,
ParWrapper  option
throws SPSignwareException [package]
 

Create a new SignWare template option that represents a data type

Parameters:
iType [i] the type contained in the option
option [i] the value
Exceptions:
SPSignwareException when an unknown type is passed
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)


Member Function Documentation

byte de.softpro.signware.SPTemplateOption.getByte  )  throws SPSignwareException
 

Query the value of this object.

Returns:
byte the value of this object
Exceptions:
SPSignwareException if the object does not contain a byte
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)

int de.softpro.signware.SPTemplateOption.getInt  )  throws SPSignwareException
 

Query the value of this object.

Returns:
int the value of this object
Exceptions:
SPSignwareException if the object does not contain an int
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)

short de.softpro.signware.SPTemplateOption.getShort  )  throws SPSignwareException
 

Query the value of this object.

Returns:
short the value of this object
Exceptions:
SPSignwareException if the object does not contain a short
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)

String de.softpro.signware.SPTemplateOption.getString  )  throws SPSignwareException
 

Query the value of this object.

Returns:
String the value of this object
Exceptions:
SPSignwareException if the object does not contain a String
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)

int de.softpro.signware.SPTemplateOption.getType  )  throws SPSignwareException
 

brief Query the option type

Returns:
int option type
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)


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