visit Kofax web site
de.softpro.signware.SPTeller

de.softpro.signware.SPTeller Class Reference

Inheritance diagram for de.softpro.signware.SPTeller:

de.softpro.signware.SPSignwareObject List of all members.

Detailed Description

Representation of a SignBase® Teller interface object
The interface allows for accessing SignBase® functionality within SignWare®.

Operating Systems:
Windows (Win32)


Public Member Functions

void clearWorkspace () throws SPSignwareException
 Clear the workspace of the SignBase® client.
void displayAccount () throws SPSignwareException
 Diplay the account in a SignBase® client.
void displayCustomer () throws SPSignwareException
 Diplay the customer in a SignBase® client.
void displayVDBForm () throws SPSignwareException
 Diplay the VDB formular in a SignBase® client.
void displayVDBFormWithResult () throws SPSignwareException
 Diplay the VDB formular in a SignBase® client.
void displayVDBReference () throws SPSignwareException
 Diplay the VDBReference in a SignBase® client.
void displayVDBReferenceWithResult () throws SPSignwareException
 Diplay the VDBReference in a SignBase® client.
void end () throws SPSignwareException
 Terminate a SignBase® client.
void enroll () throws SPSignwareException
 Enroll into a SignBase® client.
String getAccount () throws SPSignwareException
 Query the account for a successive SignBase® client request.
String getAccountName () throws SPSignwareException
 Query the account name for a successive SignBase® client request.
long getAmount () throws SPSignwareException
 Query the amount for a successive SignBase® client request.
int getAPSVResult () throws SPSignwareException
 Query the APSV result of a previous SignBase® request.
String getBankCode () throws SPSignwareException
 Query the BankCode for a successive SignBase® client request.
String getBirthDate () throws SPSignwareException
 Query the birth date for a successive SignBase® client request.
String getBNO () throws SPSignwareException
 Query the BNO for a successive SignBase® client request.
String getCountry () throws SPSignwareException
 Query the country for a successive SignBase® client request.
String getCurrency () throws SPSignwareException
 Query the Currency for a successive SignBase® client request.
String getCustomer () throws SPSignwareException
 Query the Customer for a successive SignBase® client request.
String getCustomerName () throws SPSignwareException
 Query the customer name for a successive SignBase® client request.
String getDocRefNo () throws SPSignwareException
 Query the document reference id for a successive SignBase® client request.
int getFinalResult () throws SPSignwareException
 Query the final result of a previous SignBase® request.
String getFirstname () throws SPSignwareException
 Query the firstname for a successive SignBase® client request.
String getIndexInPrimaNota () throws SPSignwareException
 Query the document index within a prima nota for a successive SignBase® client request.
String getLastname () throws SPSignwareException
 Query the lastname for a successive SignBase® client request.
int getMatchDynamic () throws SPSignwareException
 Query the dynamic match rate of a previous SignBase® request.
int getMatchStatic () throws SPSignwareException
 Query the static match rate of a previous SignBase® request.
String getMiddlename () throws SPSignwareException
 Query the middlename for a successive SignBase® client request.
String getPosition () throws SPSignwareException
 Query the position for a successive SignBase® client request.
String getPrimaNota () throws SPSignwareException
 Query the prima nota for a successive SignBase® client request.
int getResult () throws SPSignwareException
 Query the result of a previous SignBase® request.
char getReturnImage () throws SPSignwareException
 Query the image type for a successive SignBase® client request.
String getScanDate () throws SPSignwareException
 Query the scan date for a successive SignBase® client request.
int getSigno () throws SPSignwareException
 Query the signo of a previous SignBase® request.
char getSignoRole () throws SPSignwareException
 Query the signo role for a successive SignBase® client request.
char getSignoStyle () throws SPSignwareException
 Query the signo style for a successive SignBase® client request.
char getSignoType () throws SPSignwareException
 Query the signo type for a successive SignBase® client request.
SPTellerImage getTellerImage () throws SPSignwareException
 Query the Image for a successive SignBase® client request.
String getTitle () throws SPSignwareException
 Query the title for a successive SignBase® client request.
String getTransaction () throws SPSignwareException
 Query the transaction for a successive SignBase® client request.
boolean getVPSV () throws SPSignwareException
 Query the VPSV enable flag for a successive SignBase® client request.
void getXMLSigno () throws SPSignwareException
 Query a signatory from a SignBase® client.
String getXMLString () throws SPSignwareException
 Query the XML data for a successive SignBase® client request.
void resize () throws SPSignwareException
 Resize the SignBase® client window.
void setAccount (String strName) throws SPSignwareException
 Set the Account for a successive SignBase® client request.
void setAccountName (String strName) throws SPSignwareException
 Set the AccountName for a successive SignBase® client request.
void setAmount (long lAmount) throws SPSignwareException
 Set the Amount for a successive SignBase® client request.
void setBankCode (String strName) throws SPSignwareException
 Set the BankCode for a successive SignBase® client request.
void setBirthDate (String strName) throws SPSignwareException
 Set the BirthDate for a successive SignBase® client request.
void setBNO (String strName) throws SPSignwareException
 Set the BNO for a successive SignBase® client request.
void setCountry (String strName) throws SPSignwareException
 Set the Country for a successive SignBase® client request.
void setCurrency (String strName) throws SPSignwareException
 Set the Currency for a successive SignBase® client request.
void setCustomer (String strName) throws SPSignwareException
 Set the Customer for a successive SignBase® client request.
void setCustomerName (String strName) throws SPSignwareException
 Set the customer name for a successive SignBase® client request.
void setDocRefNo (String strName) throws SPSignwareException
 Set the document reference id for a successive SignBase® client request.
void setFirstname (String strName) throws SPSignwareException
 Set the Firstname for a successive SignBase® client request.
void setIndexInPrimaNota (String strName) throws SPSignwareException
 Set the document index within a prima nota for a successive SignBase® client request.
void setIniFile (String strName) throws SPSignwareException
 Set the name of the ini file for a SignBase® client process.
void setLastname (String strName) throws SPSignwareException
 Set the Lastname for a successive SignBase® client request.
void setMiddlename (String strName) throws SPSignwareException
 Set the Middlename for a successive SignBase® client request.
void setPosition (String strName) throws SPSignwareException
 Set the Position for a successive SignBase® client request.
void setPrimaNota (String strName) throws SPSignwareException
 Set the prima nota for a successive SignBase® client request.
void setReturnImage (char chPar) throws SPSignwareException
 Set the image type for a successive SignBase® client request.
void setScanDate (String strName) throws SPSignwareException
 Set the ScanDate for a successive SignBase® client request.
void setSignoRole (char chPar) throws SPSignwareException
 Set the signo role for a successive SignBase® client request.
void setSignoStyle (char chPar) throws SPSignwareException
 Set the signo style for a successive SignBase® client request.
void setSignoType (char chPar) throws SPSignwareException
 Set the signo type for a successive SignBase® client request.
void setTellerImage (SPTellerImage ti) throws SPSignwareException
 Set the Image for a successive SignBase® client request.
void setTitle (String strName) throws SPSignwareException
 Set the Title for a successive SignBase® client request.
void setTransaction (String strName) throws SPSignwareException
 Set the Transaction for a successive SignBase® client request.
void setVPSV (boolean bEnable) throws SPSignwareException
 Set the VPSV enable flag for a successive SignBase® client request.
void setXMLString (String strName) throws SPSignwareException
 Set the XML data for a successive SignBase® client request.
 SPTeller () throws SPSignwareException
 Create a teller object.
void start () throws SPSignwareException
 Start a SignBase® client.
void verify () throws SPSignwareException
 Verify in a SignBase® client.
void xmlCommand (char chAction) throws SPSignwareException
 Execute a XML command in SignBase®.

Package Functions

native final int jniFree ()

Constructor & Destructor Documentation

de.softpro.signware.SPTeller.SPTeller (   )  throws SPSignwareException
 

Create a teller object.

Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerCreate

Member Function Documentation

void de.softpro.signware.SPTeller.clearWorkspace (   )  throws SPSignwareException
 

Clear the workspace of the SignBase® client.

Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerClearWorkspace

void de.softpro.signware.SPTeller.displayAccount (   )  throws SPSignwareException
 

Diplay the account in a SignBase® client.

These parameters are passed to SignBase®:

  • BNO
  • BankCode
  • Country
  • Customer
  • Account
Please set the parameters before you call displayAccount.

The detailed result is available with getResult.

Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
setBNO, setBankCode, setCountry, setCustomer, setAccount

SPTellerDisplayAccount

void de.softpro.signware.SPTeller.displayCustomer (   )  throws SPSignwareException
 

Diplay the customer in a SignBase® client.

These parameters are passed to SignBase®:

  • BNO
  • BankCode
  • Country
  • Customer
Please set the parameters before you call displayCustomer.

The detailed result is available with getResult

Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
setBNO, setBankCode, setCountry, setCustomer

SPTellerDisplayCustomer

void de.softpro.signware.SPTeller.displayVDBForm (   )  throws SPSignwareException
 

Diplay the VDB formular in a SignBase® client.

These parameters are passed to SignBase®:

  • Prima nota
  • document index within prima nota

Please set the parameters before you call displayVDBForm.

The detailed result is available with getResult.

Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
setPrimaNota, setIndexInPrimaNota

SPTellerDisplayVDBForm

void de.softpro.signware.SPTeller.displayVDBFormWithResult (   )  throws SPSignwareException
 

Diplay the VDB formular in a SignBase® client.

These parameters are actually passed to SignBase®:

  • Prima nota
  • document index within prima nota
Please set the parameters before you call displayVDBFormWithReference.

Call getResult to obtain the result.

Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
setPrimaNota, setIndexInPrimaNota

SPTellerDisplayVDBFormWithResult

void de.softpro.signware.SPTeller.displayVDBReference (   )  throws SPSignwareException
 

Diplay the VDBReference in a SignBase® client.

These parameters are passed to SignBase®:

  • document refence number
Please set the parameters before you call DisplayVDBReference.

The detailed result is available with getResult.

Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
setDocRefNo

SPTellerDisplayVDBReference

void de.softpro.signware.SPTeller.displayVDBReferenceWithResult (   )  throws SPSignwareException
 

Diplay the VDBReference in a SignBase® client.

These parameters are passed to SignBase®:

  • document refence number
Please set the parameters before you call DisplayVDBReferenceWithResult.

Call getResult to obtain the result.

Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
setDocRefNo

SPTellerDisplayVDBReferenceWithResult

void de.softpro.signware.SPTeller.end (   )  throws SPSignwareException
 

Terminate a SignBase® client.

Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerEnd

void de.softpro.signware.SPTeller.enroll (   )  throws SPSignwareException
 

Enroll into a SignBase® client.

These parameters are passed to SignBase®:

  • BNO
  • BankCode
  • Country
  • Currency
  • Customer
  • Account
  • Lastname
  • Middlename
  • Firstname
  • Title
  • Position
  • Role
  • Style
  • Type
  • BirthDate // Date entries: 'YYYY-MM-DD'
  • ScanDate
  • CustomerType
  • CustomerName
  • AccountName
  • TellerImage
Please set the parameters before you call enroll.

The detailed result is available with getFinalResult.

Enroll will finally copy the returned data into this object. Use the parameter get functions to query the updated values.

Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
setBNO, setBankCode, setCountry, setCurrency, setCustomer, setAccount, setTransaction, setAmount, setTellerImage, setFirstname, setMiddlename, setLastname, setTitle, setPosition, setBirthDate, setScanDate, setAccountName, setCustomerName, setRole, setStyle, setType

SPTellerEnroll

String de.softpro.signware.SPTeller.getAccount (   )  throws SPSignwareException
 

Query the account for a successive SignBase® client request.

Returns:
String the account
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerGetAccount

String de.softpro.signware.SPTeller.getAccountName (   )  throws SPSignwareException
 

Query the account name for a successive SignBase® client request.

Returns:
String the account name
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerGetAccountName

long de.softpro.signware.SPTeller.getAmount (   )  throws SPSignwareException
 

Query the amount for a successive SignBase® client request.

Returns:
long the amount
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerGetAmount

int de.softpro.signware.SPTeller.getAPSVResult (   )  throws SPSignwareException
 

Query the APSV result of a previous SignBase® request.

Exceptions:
SPSignwareException on errors
Returns:
the APSV result
Operating Systems:
Windows (Win32)
See also:
SPTellerGetAPSVResult

String de.softpro.signware.SPTeller.getBankCode (   )  throws SPSignwareException
 

Query the BankCode for a successive SignBase® client request.

Returns:
String the bank code
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerGetBankCode

String de.softpro.signware.SPTeller.getBirthDate (   )  throws SPSignwareException
 

Query the birth date for a successive SignBase® client request.

Returns:
String the birth date
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerGetBirthDate

String de.softpro.signware.SPTeller.getBNO (   )  throws SPSignwareException
 

Query the BNO for a successive SignBase® client request.

Returns:
String the BNO
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerGetBNO

String de.softpro.signware.SPTeller.getCountry (   )  throws SPSignwareException
 

Query the country for a successive SignBase® client request.

Returns:
String the country
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerGetCountry

String de.softpro.signware.SPTeller.getCurrency (   )  throws SPSignwareException
 

Query the Currency for a successive SignBase® client request.

Returns:
String the Currency
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerGetCurrency

String de.softpro.signware.SPTeller.getCustomer (   )  throws SPSignwareException
 

Query the Customer for a successive SignBase® client request.

Returns:
String the customer
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerGetCustomer

String de.softpro.signware.SPTeller.getCustomerName (   )  throws SPSignwareException
 

Query the customer name for a successive SignBase® client request.

Returns:
String the customer name
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerGetCustomerName

String de.softpro.signware.SPTeller.getDocRefNo (   )  throws SPSignwareException
 

Query the document reference id for a successive SignBase® client request.

Returns:
String the document reference id
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerGetDocRefNo

int de.softpro.signware.SPTeller.getFinalResult (   )  throws SPSignwareException
 

Query the final result of a previous SignBase® request.

Exceptions:
SPSignwareException on errors
Returns:
the final result
Operating Systems:
Windows (Win32)
See also:
SPTellerGetFinalResult

String de.softpro.signware.SPTeller.getFirstname (   )  throws SPSignwareException
 

Query the firstname for a successive SignBase® client request.

Returns:
String the firstname
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerGetFirstname

String de.softpro.signware.SPTeller.getIndexInPrimaNota (   )  throws SPSignwareException
 

Query the document index within a prima nota for a successive SignBase® client request.

Returns:
String the document index
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerGetIndexInPrimaNota

String de.softpro.signware.SPTeller.getLastname (   )  throws SPSignwareException
 

Query the lastname for a successive SignBase® client request.

Returns:
String the lastname
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerGetLastname

int de.softpro.signware.SPTeller.getMatchDynamic (   )  throws SPSignwareException
 

Query the dynamic match rate of a previous SignBase® request.

Exceptions:
SPSignwareException on errors
Returns:
the dynamic match rate
Operating Systems:
Windows (Win32)
See also:
SPTellerGetMatchDynamic

int de.softpro.signware.SPTeller.getMatchStatic (   )  throws SPSignwareException
 

Query the static match rate of a previous SignBase® request.

Exceptions:
SPSignwareException on errors
Returns:
the static match rate
Operating Systems:
Windows (Win32)
See also:
SPTellerGetMatchStatic

String de.softpro.signware.SPTeller.getMiddlename (   )  throws SPSignwareException
 

Query the middlename for a successive SignBase® client request.

Returns:
String the middlename
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerGetMiddlename

String de.softpro.signware.SPTeller.getPosition (   )  throws SPSignwareException
 

Query the position for a successive SignBase® client request.

Returns:
String the position
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerGetPosition

String de.softpro.signware.SPTeller.getPrimaNota (   )  throws SPSignwareException
 

Query the prima nota for a successive SignBase® client request.

Returns:
String the prima nota
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerGetPrimaNota

int de.softpro.signware.SPTeller.getResult (   )  throws SPSignwareException
 

Query the result of a previous SignBase® request.

Exceptions:
SPSignwareException on errors
Returns:
the final result
Operating Systems:
Windows (Win32)
See also:
SPTellerGetResult

char de.softpro.signware.SPTeller.getReturnImage (   )  throws SPSignwareException
 

Query the image type for a successive SignBase® client request.

Returns:
char the image type
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerGetReturnImage

String de.softpro.signware.SPTeller.getScanDate (   )  throws SPSignwareException
 

Query the scan date for a successive SignBase® client request.

Returns:
String the scan date
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerGetScanDate

int de.softpro.signware.SPTeller.getSigno (   )  throws SPSignwareException
 

Query the signo of a previous SignBase® request.

Exceptions:
SPSignwareException on errors
Returns:
the signo
Operating Systems:
Windows (Win32)
See also:
SPTellerGetSigno

char de.softpro.signware.SPTeller.getSignoRole (   )  throws SPSignwareException
 

Query the signo role for a successive SignBase® client request.

Returns:
char the role
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerGetRole

char de.softpro.signware.SPTeller.getSignoStyle (   )  throws SPSignwareException
 

Query the signo style for a successive SignBase® client request.

Returns:
char the style
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerGetStyle

char de.softpro.signware.SPTeller.getSignoType (   )  throws SPSignwareException
 

Query the signo type for a successive SignBase® client request.

Returns:
char the type
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerGetType

SPTellerImage de.softpro.signware.SPTeller.getTellerImage (   )  throws SPSignwareException
 

Query the Image for a successive SignBase® client request.

Returns:
TellerImage the teller image object
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerSetTellerImage

String de.softpro.signware.SPTeller.getTitle (   )  throws SPSignwareException
 

Query the title for a successive SignBase® client request.

Returns:
String the title
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerGetTitle

String de.softpro.signware.SPTeller.getTransaction (   )  throws SPSignwareException
 

Query the transaction for a successive SignBase® client request.

Returns:
String the transaction
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerGetTransaction

boolean de.softpro.signware.SPTeller.getVPSV (   )  throws SPSignwareException
 

Query the VPSV enable flag for a successive SignBase® client request.

Returns:
boolean flag whether VPSV is enabled or not
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerGetEnableVPSV

void de.softpro.signware.SPTeller.getXMLSigno (   )  throws SPSignwareException
 

Query a signatory from a SignBase® client.

These parameters are passed to SignBase®:

  • BNO
  • BankCode
  • Country
  • Customer
  • Account
  • ReturnImage
Please set the parameters before you call getXMLSigno.

The detailed result is available with getResult, the result string may be called via getXMLString

Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
setBNO, setBankCode, setCountry, setCustomer, setAccount, setReturnImage

SPTellerGetXMLSigno

String de.softpro.signware.SPTeller.getXMLString (   )  throws SPSignwareException
 

Query the XML data for a successive SignBase® client request.

Returns:
String the XML data
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerGetXMLString

native final int de.softpro.signware.SPTeller.jniFree (   )  [package, virtual]
 

Implements de.softpro.signware.SPSignwareObject.

void de.softpro.signware.SPTeller.resize (   )  throws SPSignwareException
 

Resize the SignBase® client window.

Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerResize

void de.softpro.signware.SPTeller.setAccount (  String  strName  )  throws SPSignwareException
 

Set the Account for a successive SignBase® client request.

Parameters:
strName [i] the Account number
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerSetBankCode

void de.softpro.signware.SPTeller.setAccountName (  String  strName  )  throws SPSignwareException
 

Set the AccountName for a successive SignBase® client request.

Parameters:
strName [i] the AccountName
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerSetAccountName

void de.softpro.signware.SPTeller.setAmount (  long  lAmount  )  throws SPSignwareException
 

Set the Amount for a successive SignBase® client request.

Parameters:
lAmount [i] the amount
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerSet

void de.softpro.signware.SPTeller.setBankCode (  String  strName  )  throws SPSignwareException
 

Set the BankCode for a successive SignBase® client request.

Parameters:
strName [i] the BankCode
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerSetBankCode

void de.softpro.signware.SPTeller.setBirthDate (  String  strName  )  throws SPSignwareException
 

Set the BirthDate for a successive SignBase® client request.

Parameters:
strName [i] the BirthDate [format 'YYYY-MM-DD']
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerSetBirthDate

void de.softpro.signware.SPTeller.setBNO (  String  strName  )  throws SPSignwareException
 

Set the BNO for a successive SignBase® client request.

Parameters:
strName [i] the BNO
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerSetBNO

void de.softpro.signware.SPTeller.setCountry (  String  strName  )  throws SPSignwareException
 

Set the Country for a successive SignBase® client request.

Parameters:
strName [i] the Country
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerSetCountry

void de.softpro.signware.SPTeller.setCurrency (  String  strName  )  throws SPSignwareException
 

Set the Currency for a successive SignBase® client request.

Parameters:
strName [i] the
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerSetCurrency

void de.softpro.signware.SPTeller.setCustomer (  String  strName  )  throws SPSignwareException
 

Set the Customer for a successive SignBase® client request.

Parameters:
strName [i] the Customer number
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerSetCustomer

void de.softpro.signware.SPTeller.setCustomerName (  String  strName  )  throws SPSignwareException
 

Set the customer name for a successive SignBase® client request.

Parameters:
strName [i] the customer name
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerSetCustomerName

void de.softpro.signware.SPTeller.setDocRefNo (  String  strName  )  throws SPSignwareException
 

Set the document reference id for a successive SignBase® client request.

Parameters:
strName [i] the document
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerSetDocRefNo

void de.softpro.signware.SPTeller.setFirstname (  String  strName  )  throws SPSignwareException
 

Set the Firstname for a successive SignBase® client request.

Parameters:
strName [i] the Firstname
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerSetFirstname

void de.softpro.signware.SPTeller.setIndexInPrimaNota (  String  strName  )  throws SPSignwareException
 

Set the document index within a prima nota for a successive SignBase® client request.

Parameters:
strName [i] the document index
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerSetIndexInPrimaNota

void de.softpro.signware.SPTeller.setIniFile (  String  strName  )  throws SPSignwareException
 

Set the name of the ini file for a SignBase® client process.

Parameters:
strName [i] the name of the configuration file
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerSetIniFile

void de.softpro.signware.SPTeller.setLastname (  String  strName  )  throws SPSignwareException
 

Set the Lastname for a successive SignBase® client request.

Parameters:
strName [i] the Lastname
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerSetLastname

void de.softpro.signware.SPTeller.setMiddlename (  String  strName  )  throws SPSignwareException
 

Set the Middlename for a successive SignBase® client request.

Parameters:
strName [i] the Middlename
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerSetMiddlename

void de.softpro.signware.SPTeller.setPosition (  String  strName  )  throws SPSignwareException
 

Set the Position for a successive SignBase® client request.

Parameters:
strName [i] the Position
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerSetPosition

void de.softpro.signware.SPTeller.setPrimaNota (  String  strName  )  throws SPSignwareException
 

Set the prima nota for a successive SignBase® client request.

Parameters:
strName [i] the prima nota
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerSetPrimaNota

void de.softpro.signware.SPTeller.setReturnImage (  char  chPar  )  throws SPSignwareException
 

Set the image type for a successive SignBase® client request.

Parameters:
chPar [i] the Type
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerSetReturnImage

void de.softpro.signware.SPTeller.setScanDate (  String  strName  )  throws SPSignwareException
 

Set the ScanDate for a successive SignBase® client request.

Parameters:
strName [i] the ScanDate [format 'YYYY-MM-DD']
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerSetScanDate

void de.softpro.signware.SPTeller.setSignoRole (  char  chPar  )  throws SPSignwareException
 

Set the signo role for a successive SignBase® client request.

Parameters:
chPar [i] the role
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerSetRole

void de.softpro.signware.SPTeller.setSignoStyle (  char  chPar  )  throws SPSignwareException
 

Set the signo style for a successive SignBase® client request.

Parameters:
chPar [i] the Style
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerSetStyle

void de.softpro.signware.SPTeller.setSignoType (  char  chPar  )  throws SPSignwareException
 

Set the signo type for a successive SignBase® client request.

Parameters:
chPar [i] the Type
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerSetType

void de.softpro.signware.SPTeller.setTellerImage (  SPTellerImage  ti  )  throws SPSignwareException
 

Set the Image for a successive SignBase® client request.

Parameters:
ti [i] the image as a SPTellerImage object
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerSetTellerImage

void de.softpro.signware.SPTeller.setTitle (  String  strName  )  throws SPSignwareException
 

Set the Title for a successive SignBase® client request.

Parameters:
strName [i] the Title
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerSetTitle

void de.softpro.signware.SPTeller.setTransaction (  String  strName  )  throws SPSignwareException
 

Set the Transaction for a successive SignBase® client request.

Parameters:
strName [i] the transaction
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerSetTransaction

void de.softpro.signware.SPTeller.setVPSV (  boolean  bEnable  )  throws SPSignwareException
 

Set the VPSV enable flag for a successive SignBase® client request.

Parameters:
bEnable [i] flag to enable VPSV
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerSetEnableVPSV

void de.softpro.signware.SPTeller.setXMLString (  String  strName  )  throws SPSignwareException
 

Set the XML data for a successive SignBase® client request.

Parameters:
strName [i] the XML data
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerSetXMLString

void de.softpro.signware.SPTeller.start (   )  throws SPSignwareException
 

Start a SignBase® client.

Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerStart

void de.softpro.signware.SPTeller.verify (   )  throws SPSignwareException
 

Verify in a SignBase® client.

These parameters are passed to SignBase®:

  • BNO
  • BankCode
  • Country
  • Currency
  • Customer
  • Account
  • Transaction
  • Amount
  • TellerImage
Please set the parameters before you call verify.

The detailed results are available with getSigno.

Verify will finally copy the returned data into this object. Use the parameter get functions to query the updated values.

Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
setBNO, setBankCode, setCountry, setCurrency, setCustomer, setAccount, setTransaction, setAmount, setTellerImage

SPTellerVerify getFinalResult, getAPSVResult, getMatchStatic, getMatchDynamic

void de.softpro.signware.SPTeller.xmlCommand (  char  chAction  )  throws SPSignwareException
 

Execute a XML command in SignBase®.

These parameters are passed to SignBase®:

  • XMLString
Please set the parameters before you call xmlCommand.

The detailed result is available with getResult.

Parameters:
chAction [i] action specifier
  • '1': create a new customer / account / signatory entry, error if existing
  • '2': update a customer / account / signatory entry, create new
  • '3': update a customer / account / signatory entry, error if not existing
  • '4': delete a customer / account / signatory entry, error if not existing
  • '5': update and append a customer / account / signatory entry
  • '6': append a customer / account / signatory entry, don't modify existing
  • '7': combination of actions "4" plus "1"
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
setXMLString

SPTellerXMLCommand

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