de.softpro.doc.SignDocException Class Reference

SignDoc exception. More...

Inheritance diagram for de.softpro.doc.SignDocException:

List of all members.

Public Member Functions
	SignDocException (int aCode)
	Constructor, without message.
	SignDocException (int aCode, String aMsg)
	Constructor, with message.
int	errorCode ()
	Get the error code.
Public Attributes
int	mCode
Static Public Attributes
static final int	rc_invalid_argument = 1
	Error code: Invalid argument.
static final int	rc_field_not_found = 2
	Error code: Field not found (or not a signature field).
static final int	rc_invalid_profile = 3
	Error code: Profile unknown or not applicable.
static final int	rc_invalid_image = 4
	Error code: Invalid image (e.g., unsupported format).
static final int	rc_type_mismatch = 5
	Error code: Field type or property type mismatch.
static final int	rc_font_not_found = 6
	Error code: The requested font could not be found or does not contain all required characters.
static final int	rc_no_datablock = 7
	Error code: No datablock found (obsolete).
static final int	rc_not_supported = 8
	Error code: Operation not supported.
static final int	rc_io_error = 9
	Error code: I/O error.
static final int	rc_not_verified = 10
	Error code: SignDocDocument.verifySignature() has not been called.
static final int	rc_property_not_found = 11
	Error code: Property not found.
static final int	rc_page_not_found = 12
	Error code: Page not found (invalid page number).
static final int	rc_wrong_collection = 13
	Error code: Property accessed via wrong collection.
static final int	rc_field_exists = 14
	Error code: Field already exists.
static final int	rc_license_error = 15
	Error code: License initialization failed or license check failed.
static final int	rc_unexpected_error = 16
	Error code: Unexpected error.
static final int	rc_cancelled = 17
	Error code: Certificate dialog cancelled by user.
static final int	rc_no_biometric_data = 18
	Error code: No biometric data available.
static final int	rc_parameter_not_set = 19
	Error code: Parameter not set (Java only).
static final int	rc_field_not_signed = 20
	Error code: Field not signed, for SignDocDocument.copyAsSignedToStream()
static final int	rc_invalid_signature = 21
	Error code: Signature is not valid, for SignDocDocument.copyAsSignedToStream() and SignDocDocument.updateDSS()
static final int	rc_annotation_not_found = 22
	Error code: Annotation not found, for SignDocDocument.getAnnotation()
static final int	rc_attachment_not_found = 23
	Error code: Attachment not found.
static final int	rc_attachment_exists = 24
	Error code: Attachment already exists.
static final int	rc_no_certificate = 25
	Error code: No (matching) certificate found and csf_create_self_signed is not specified.
static final int	rc_ambiguous_certificate = 26
	Error code: More than one matching certificate found and csf_never_ask is specified.
static final int	rc_not_allowed = 27
	Error code: Operation not allowed due to document being signed or conforming to PDF/A.
static final int	rc_invalid_structure = 28
	Error code: Document has invalid logical structure.

---

Detailed Description

SignDoc exception.

---

Constructor & Destructor Documentation

de.softpro.doc.SignDocException.SignDocException

(

int

aCode )

Constructor, without message.

Parameters:

[in]

aCode

The error code.

de.softpro.doc.SignDocException.SignDocException	(	int	aCode,
		String	aMsg
	)

Constructor, with message.

Parameters:

[in]	aCode	The error code.
[in]	aMsg	The message.

---

Member Function Documentation

int de.softpro.doc.SignDocException.errorCode

(

)

Get the error code.

Returns:

The error code.

---

Member Data Documentation

int de.softpro.doc.SignDocException.mCode

final int de.softpro.doc.SignDocException.rc_ambiguous_certificate = 26 [static]

Error code: More than one matching certificate found and csf_never_ask is specified.

final int de.softpro.doc.SignDocException.rc_annotation_not_found = 22 [static]

Error code: Annotation not found, for SignDocDocument.getAnnotation()

final int de.softpro.doc.SignDocException.rc_attachment_exists = 24 [static]

Error code: Attachment already exists.

final int de.softpro.doc.SignDocException.rc_attachment_not_found = 23 [static]

Error code: Attachment not found.

final int de.softpro.doc.SignDocException.rc_cancelled = 17 [static]

Error code: Certificate dialog cancelled by user.

final int de.softpro.doc.SignDocException.rc_field_exists = 14 [static]

Error code: Field already exists.

final int de.softpro.doc.SignDocException.rc_field_not_found = 2 [static]

Error code: Field not found (or not a signature field).

final int de.softpro.doc.SignDocException.rc_field_not_signed = 20 [static]

Error code: Field not signed, for SignDocDocument.copyAsSignedToStream()

final int de.softpro.doc.SignDocException.rc_font_not_found = 6 [static]

Error code: The requested font could not be found or does not contain all required characters.

See also SignDocDocument.setShootInFoot().

final int de.softpro.doc.SignDocException.rc_invalid_argument = 1 [static]

Error code: Invalid argument.

final int de.softpro.doc.SignDocException.rc_invalid_image = 4 [static]

Error code: Invalid image (e.g., unsupported format).

final int de.softpro.doc.SignDocException.rc_invalid_profile = 3 [static]

Error code: Profile unknown or not applicable.

final int de.softpro.doc.SignDocException.rc_invalid_signature = 21 [static]

Error code: Signature is not valid, for SignDocDocument.copyAsSignedToStream() and SignDocDocument.updateDSS()

final int de.softpro.doc.SignDocException.rc_invalid_structure = 28 [static]

Error code: Document has invalid logical structure.

See also:

SignDocDocument.f_fail_for_broken_target_structure

final int de.softpro.doc.SignDocException.rc_io_error = 9 [static]

Error code: I/O error.

final int de.softpro.doc.SignDocException.rc_license_error = 15 [static]

Error code: License initialization failed or license check failed.

final int de.softpro.doc.SignDocException.rc_no_biometric_data = 18 [static]

Error code: No biometric data available.

final int de.softpro.doc.SignDocException.rc_no_certificate = 25 [static]

Error code: No (matching) certificate found and csf_create_self_signed is not specified.

final int de.softpro.doc.SignDocException.rc_no_datablock = 7 [static]

Error code: No datablock found (obsolete).

final int de.softpro.doc.SignDocException.rc_not_allowed = 27 [static]

Error code: Operation not allowed due to document being signed or conforming to PDF/A.

See also:

SignDocDocument.removePDFA(), SignDocDocument.removePDFUA(), SignDocDocument.setShootInFoot()

final int de.softpro.doc.SignDocException.rc_not_supported = 8 [static]

Error code: Operation not supported.

final int de.softpro.doc.SignDocException.rc_not_verified = 10 [static]

Error code: SignDocDocument.verifySignature() has not been called.

final int de.softpro.doc.SignDocException.rc_page_not_found = 12 [static]

Error code: Page not found (invalid page number).

final int de.softpro.doc.SignDocException.rc_parameter_not_set = 19 [static]

Error code: Parameter not set (Java only).

final int de.softpro.doc.SignDocException.rc_property_not_found = 11 [static]

Error code: Property not found.

final int de.softpro.doc.SignDocException.rc_type_mismatch = 5 [static]

Error code: Field type or property type mismatch.

final int de.softpro.doc.SignDocException.rc_unexpected_error = 16 [static]

Error code: Unexpected error.

final int de.softpro.doc.SignDocException.rc_wrong_collection = 13 [static]

Error code: Property accessed via wrong collection.

---

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

• de/softpro/doc/SignDocException.java