at.gv.egiz.pdfas.api.commons
Class DynamicSignatureProfileImpl

java.lang.Object
  extended by at.gv.egiz.pdfas.api.commons.DynamicSignatureProfileImpl
All Implemented Interfaces:
DynamicSignatureProfile

public class DynamicSignatureProfileImpl
extends Object
implements DynamicSignatureProfile

Implementation class of the DynamicSignatureProfile. Don't use this class directly. Use PdfAs to create and the DynamicSignatureProfile interface for manipulation.

Author:
exthex

Method Summary
 void apply()
          Apply the signature profile.
static DynamicSignatureProfileImpl createEmptyProfile(String myUniqueName, DynamicSignatureLifetimeEnum mode)
           
static DynamicSignatureProfileImpl createFromParent(String myUniqueName, String parentProfile, DynamicSignatureLifetimeEnum mode)
           
 void dispose()
          Disposes the signature profile from the global store.
static void disposeLocalProfile()
           
 String getFieldValue(String fieldName)
          Get a field value from the profile.
 String getName()
          Get the name of the dynamic signature profile.
 String getPropertyRaw(String key)
          Get any property from the signature profile.
static DynamicSignatureProfileImpl loadProfile(String name)
           
 void setFieldValue(String fieldName, String value)
          Set a field value for the profile.
 void setName(String uniqueName)
           
 void setPropertyRaw(String key, String val)
          Set any property for the signature profile.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

createFromParent

public static DynamicSignatureProfileImpl createFromParent(String myUniqueName,
                                                           String parentProfile,
                                                           DynamicSignatureLifetimeEnum mode)

disposeLocalProfile

public static void disposeLocalProfile()

createEmptyProfile

public static DynamicSignatureProfileImpl createEmptyProfile(String myUniqueName,
                                                             DynamicSignatureLifetimeEnum mode)

loadProfile

public static DynamicSignatureProfileImpl loadProfile(String name)

getName

public String getName()
Description copied from interface: DynamicSignatureProfile
Get the name of the dynamic signature profile. Equals the SignatureProfileId

Specified by:
getName in interface DynamicSignatureProfile
Returns:

setName

public void setName(String uniqueName)

setPropertyRaw

public void setPropertyRaw(String key,
                           String val)
Description copied from interface: DynamicSignatureProfile
Set any property for the signature profile. Uses the same keys as the property file without the "prefix" for the profile. For example to set sig_obj.MEIN_DYN_SIGNATURBLOCK.key.SIG_META use key.SIG_META

Specified by:
setPropertyRaw in interface DynamicSignatureProfile
Parameters:
key - property key
val - property value

getPropertyRaw

public String getPropertyRaw(String key)
Description copied from interface: DynamicSignatureProfile
Get any property from the signature profile. See DynamicSignatureProfile.setPropertyRaw(String, String) for details.

Specified by:
getPropertyRaw in interface DynamicSignatureProfile
Returns:

setFieldValue

public void setFieldValue(String fieldName,
                          String value)
Description copied from interface: DynamicSignatureProfile
Set a field value for the profile. Use DynamicSignatureProfile.setPropertyRaw(String, String) for setting any property.
For example to set sig_obj.MEIN_DYN_SIGNATURBLOCK.value.SIG_META just use SIG_META as fieldName.

Specified by:
setFieldValue in interface DynamicSignatureProfile
Parameters:
fieldName - the name of the field
value - the value to set

getFieldValue

public String getFieldValue(String fieldName)
Description copied from interface: DynamicSignatureProfile
Get a field value from the profile. See DynamicSignatureProfile.setFieldValue(String, String)

Specified by:
getFieldValue in interface DynamicSignatureProfile
Returns:

apply

public void apply()
Description copied from interface: DynamicSignatureProfile
Apply the signature profile. Call this after all properties are set and you want to use the profile. It is then added to the globally available signature profiles. Depending on the lifetime model DynamicSignatureLifetimeEnum you have to DynamicSignatureProfile.dispose() it manually when not needed anymore.

Specified by:
apply in interface DynamicSignatureProfile

dispose

public void dispose()
Description copied from interface: DynamicSignatureProfile
Disposes the signature profile from the global store. Call this for DynamicSignatureLifetimeEnum.MANUAL only.

Specified by:
dispose in interface DynamicSignatureProfile


Copyright © 2006-2011. All Rights Reserved.