visit Kofax web site
de.softpro.signware.SPPropertyMap

de.softpro.signware.SPPropertyMap Class Reference

Inheritance diagram for de.softpro.signware.SPPropertyMap:

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

Detailed Description

a representation of a parameter container
SPPropertyMap is used in SPSignature.check and SPReference.check. SPPropertyMap can be serialized and deserialized

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


Public Member Functions

boolean equals (SPPropertyMap aMap) throws SPSignwareException
 Compare a PropertyMap object.
boolean getBoolParameter (String strName) throws SPSignwareException
 Query the content of a property.
byte[] getByteArrayParameter (String strName) throws SPSignwareException
 Query the content of a property.
double getDoubleParameter (String strName) throws SPSignwareException
 Query the content of a property.
int getIntParameter (String strName) throws SPSignwareException
 Query the content of a property.
String getStringParameter (String strName) throws SPSignwareException
 Query the content of a property.
void setParameter (String strName, byte[] aValue) throws SPSignwareException
 Set the value of a property.
void setParameter (String strName, String aValue) throws SPSignwareException
 Set the value of a property.
void setParameter (String strName, double aValue) throws SPSignwareException
 Set the value of a property.
void setParameter (String strName, boolean aValue) throws SPSignwareException
 Set the value of a property.
void setParameter (String strName, int aValue) throws SPSignwareException
 Set the value of a property.
 SPPropertyMap (byte[] flatFile) throws SPSignwareException
 Create a PropertyMap object from a flatfile.
 SPPropertyMap (SPPropertyMap clone) throws SPSignwareException
 Copy an SPPropertyMap object.
 SPPropertyMap () throws SPSignwareException
 Create a property map object.

Package Functions

native final int jniFree ()

Constructor & Destructor Documentation

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

Create a property map object.

Exceptions:
SPSignwareException on error
  • SP_MEMORYERR out of memory
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPPropertyMapCreate

de.softpro.signware.SPPropertyMap.SPPropertyMap (  SPPropertyMap  clone  )  throws SPSignwareException
 

Copy an SPPropertyMap object.

The newly created object will be a true copy of the copied object.

Parameters:
clone [i] the object to be copied
Exceptions:
SPSignwareException on error
  • SP_MEMORYERR out of memory
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPPropertyMapClone

de.softpro.signware.SPPropertyMap.SPPropertyMap (  byte[]  flatFile  )  throws SPSignwareException
 

Create a PropertyMap object from a flatfile.

Parameters:
flatFile [i] the serialized PropertyMap
Exceptions:
SPSignwareException on error
  • SP_MEMORYERR out of memory
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPPropertyMapRead

Member Function Documentation

boolean de.softpro.signware.SPPropertyMap.equals (  SPPropertyMap  aMap  )  throws SPSignwareException
 

Compare a PropertyMap object.

Parameters:
aMap [i] the map to compare
Returns:
boolean true if both maps are equal
Exceptions:
SPSignwareException on error
  • SP_MEMORYERR out of memory
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPPropertyMapRead

boolean de.softpro.signware.SPPropertyMap.getBoolParameter (  String  strName  )  throws SPSignwareException
 

Query the content of a property.

Parameters:
strName [i] the name of the property
Returns:
bool the contents of the property.
Exceptions:
SPSignwareException on error
  • SP_PARAMERR undefined property, or not an integer
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPPropertyMapGetBool

byte [] de.softpro.signware.SPPropertyMap.getByteArrayParameter (  String  strName  )  throws SPSignwareException
 

Query the content of a property.

Parameters:
strName [i] the name of the property
Returns:
byte[] the contents of the property.
Exceptions:
SPSignwareException on error
  • SP_PARAMERR undefined property
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPPropertyMapGetData

double de.softpro.signware.SPPropertyMap.getDoubleParameter (  String  strName  )  throws SPSignwareException
 

Query the content of a property.

Parameters:
strName [i] the name of the property
Returns:
double the contents of the property.
Exceptions:
SPSignwareException on error
  • SP_PARAMERR undefined property, or not an integer and not a double
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPPropertyMapGetDouble

int de.softpro.signware.SPPropertyMap.getIntParameter (  String  strName  )  throws SPSignwareException
 

Query the content of a property.

Parameters:
strName [i] the name of the property
Returns:
int the contents of the property.
Exceptions:
SPSignwareException on error
  • SP_PARAMERR undefined property, or not an integer
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPPropertyMapGetInt

String de.softpro.signware.SPPropertyMap.getStringParameter (  String  strName  )  throws SPSignwareException
 

Query the content of a property.

Parameters:
strName [i] the name of the property
Returns:
String the contents of the property.
Exceptions:
SPSignwareException on error
  • SP_PARAMERR undefined property
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPPropertyMapGetString

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

Implements de.softpro.signware.SPSignwareObject.

void de.softpro.signware.SPPropertyMap.setParameter (  String  strName,
byte[]  aValue
)  throws SPSignwareException
 

Set the value of a property.

Parameters:
strName [i] the name of the property
aValue [i] the value of the property
Exceptions:
SPSignwareException on error
  • SP_PARAMERR undefined property
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPPropertyMapSetData

void de.softpro.signware.SPPropertyMap.setParameter (  String  strName,
String  aValue
)  throws SPSignwareException
 

Set the value of a property.

Parameters:
strName [i] the name of the property
aValue [i] the value of the property
Exceptions:
SPSignwareException on error
  • SP_PARAMERR undefined property
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPPropertyMapSetString

void de.softpro.signware.SPPropertyMap.setParameter (  String  strName,
double  aValue
)  throws SPSignwareException
 

Set the value of a property.

Parameters:
strName [i] the name of the property
aValue [i] the value of the property
Exceptions:
SPSignwareException on error
  • SP_PARAMERR undefined property
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPPropertyMapSetDouble

void de.softpro.signware.SPPropertyMap.setParameter (  String  strName,
boolean  aValue
)  throws SPSignwareException
 

Set the value of a property.

Parameters:
strName [i] the name of the property
aValue [i] the value of the property
Exceptions:
SPSignwareException on error
  • SP_PARAMERR undefined property
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPPropertyMapSetBool

void de.softpro.signware.SPPropertyMap.setParameter (  String  strName,
int  aValue
)  throws SPSignwareException
 

Set the value of a property.

Parameters:
strName [i] the name of the property
aValue [i] the value of the property
Exceptions:
SPSignwareException on error
  • SP_PARAMERR undefined property
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPPropertyMapSetInt

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