com.adobe.livecycle.signatures.client.types
Class FieldMDPOptionSpec

java.lang.Object
  com.adobe.livecycle.signatures.client.types.FieldMDPOptionSpec

All Implemented Interfaces:

java.io.Serializable

public class FieldMDPOptionSpec
extends java.lang.Object
implements java.io.Serializable

The options that are set for the signature field lock dictionary associated with a given signature field. A field lock dictionary specifies a list of other fields which are locked once the signature field for which this dictionary is associated is signed. Any changes to the locked fields subsequent to signing of this signature field invalidates the signature.

The fields locked can be any form fields and not necessarily signature fields. An object of this type is passed when creating a new signature field by invoking the addSignatureField method.

An object of this type consists of two sub parts:

• An enumeration value of type FieldMDPAction, which specifies the type of action.
• An array of field names on which the action is applicable or not applicable. The array of field names is applicable only if FieldMDPAction is either INCLUDE or EXCLUDE.

For more details, see the PDF Reference (1.7, Section 8.7). To see an object of this type used in a code example, see the Modifying a signature field using the Java API quick start in Programming with LiveCycle ES4.

See Also:

Serialized Form

Constructor Summary

FieldMDPOptionSpec()
The default constructor that is equivalent to applying No FieldMDP options.

FieldMDPOptionSpec(FieldMDPAction action, java.lang.String[] fields)
A constructor that takes a FieldMDPAction object and a list of fully qualified names of form fields on which the action is applied.

Method Summary

boolean	equals(java.lang.Object obj) For internal use only.
FieldMDPAction	getAction() Returns the FieldMDPAction object that is associated with this object.
java.lang.String[]	getFields() Returns the PDF document fields associated with this object.
void	setAction(FieldMDPAction action) Sets the FieldMDPAction object associated with this object.
void	setFields(java.lang.String[] fields) Sets the PDF document fields associated with this object.
java.lang.String	toString() Returns a string representation of this class.

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FieldMDPOptionSpec

public FieldMDPOptionSpec()

The default constructor that is equivalent to applying No FieldMDP options.

FieldMDPOptionSpec

public FieldMDPOptionSpec(FieldMDPAction action,
                          java.lang.String[] fields)

A constructor that takes a FieldMDPAction object and a list of fully qualified names of form fields on which the action is applied.

Parameters:

action - The applicable FieldMDPAction object. If this value is null, fields are not locked.

fields - The list of fully qualified names of other form fields on which the specified action is applied. The list can be null only if the action is FieldMDPAction.ALL. If it contains names of fields that do not exist, they are ignored. If action is FieldMDPAction.INCLUDE or FieldMDPAction.EXCLUDE and either the list is null or evaluates to null after removing the invalid entries, fields are not locked.

Method Detail

getAction

public FieldMDPAction getAction()

Returns the FieldMDPAction object that is associated with this object.

Returns:

The FieldMDPAction object that is associated with this object.

getFields

public java.lang.String[] getFields()

Returns the PDF document fields associated with this object.

Returns:

A string array of PDF document fields associated with this object.

toString

public java.lang.String toString()

Returns a string representation of this class.

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()

equals

public boolean equals(java.lang.Object obj)

For internal use only.

Overrides:

equals in class java.lang.Object

See Also:

Object.equals(java.lang.Object)

setAction

public void setAction(FieldMDPAction action)

Sets the FieldMDPAction object associated with this object.

Parameters:

action - The FieldMDPAction object associated with this object.

setFields

public void setFields(java.lang.String[] fields)

Sets the PDF document fields associated with this object.

Parameters:

fields - A string array that represents a list of the fully qualified names of the fields located in the PDF document.