com.groupdocs.signature

Class SignatureSettings

java.lang.Object

com.groupdocs.signature.SignatureSettings

public class SignatureSettings
extends Object

Defines settings for customizing Signature behavior.

Constructor Summary

Constructors

Constructor and Description
SignatureSettings() Creates default SignatureSettings instance with default values.
SignatureSettings(ILogger logger) Creates default SignatureSettings instance with the Logger implementation.

Method Summary

Modifier and Type	Method and Description
static Locale	getDefaultCulture() Gets or sets default culture to be used during document processing.
boolean	getIncludeStandardMetadataSignatures() Gets or sets flag to include into the Metadata List the embedded standard document metadata signatures like Author, Owner, document creation date, modified date, etc.
ILogger	getLogger() The logger implementation used for logging (Errors, Warnings, Traces).
int	getLogLevel() The level of the logging to limit the messages (All, Traces, Warnings, Errors).
boolean	getSaveDocumentOnEmptyDelete() Gets or sets flag to resave source document when Delete method has no affected signatures to remove.
boolean	getSaveDocumentOnEmptyUpdate() Gets or sets flag to resave source document when Update method has no signatures to update.
boolean	getShowDeletedSiganturesInfo() Gets or sets flag that includes deleted signatures into Document Info result.
void	setDefaultCulture(Locale value) Gets or sets default culture to be used during document processing.
void	setIncludeStandardMetadataSignatures(boolean value) Gets or sets flag to include into the Metadata List the embedded standard document metadata signatures like Author, Owner, document creation date, modified date, etc.
void	setLogLevel(int value) The level of the logging to limit the messages (All, Traces, Warnings, Errors).
void	setSaveDocumentOnEmptyDelete(boolean value) Gets or sets flag to resave source document when Delete method has no affected signatures to remove.
void	setSaveDocumentOnEmptyUpdate(boolean value) Gets or sets flag to resave source document when Update method has no signatures to update.
void	setShowDeletedSiganturesInfo(boolean value) Gets or sets flag that includes deleted signatures into Document Info result.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SignatureSettings

public SignatureSettings()

Creates default SignatureSettings instance with default values.

SignatureSettings

public SignatureSettings(ILogger logger)

Creates default SignatureSettings instance with the Logger implementation.

Parameters:

logger -

Method Detail

getDefaultCulture

public static Locale getDefaultCulture()

Gets or sets default culture to be used during document processing. Default value is "en-US".

getIncludeStandardMetadataSignatures

public final boolean getIncludeStandardMetadataSignatures()

Gets or sets flag to include into the Metadata List the embedded standard document metadata signatures like Author, Owner, document creation date, modified date, etc. If this flag is set to false (by default) the GetDocumentInfo will not include these metadata signatures. When this flag is set to true the document information will include these standard metadata signatures.

getLogger

public final ILogger getLogger()

The logger implementation used for logging (Errors, Warnings, Traces). ILogger.

getLogLevel

public final int getLogLevel()

The level of the logging to limit the messages (All, Traces, Warnings, Errors). LogLevel. BY default the All level type is set.

getSaveDocumentOnEmptyDelete

public final boolean getSaveDocumentOnEmptyDelete()

Gets or sets flag to resave source document when Delete method has no affected signatures to remove. If this flag is set to true (by default) document will be saving with corresponding history process log (date and operation type) even if Delete method has no signatures to remove. When this flat is set to false source document will not be modified at all.

getSaveDocumentOnEmptyUpdate

public final boolean getSaveDocumentOnEmptyUpdate()

Gets or sets flag to resave source document when Update method has no signatures to update. If this flag is set to true (by default) document will be saving with corresponding history process log (date and operation type) even if Update method has no signatures to update. When this flat is set to false source document will not be modified at all.

getShowDeletedSiganturesInfo

public final boolean getShowDeletedSiganturesInfo()

Gets or sets flag that includes deleted signatures into Document Info result. Each Signature BaseSignature has Deleted flag BaseSignature.Deleted(BaseSignature.getDeleted()/BaseSignature.setDeleted(boolean)) to detect if it was deleted.

setDefaultCulture

public final void setDefaultCulture(Locale value)

Gets or sets default culture to be used during document processing. Default value is "en-US".

setIncludeStandardMetadataSignatures

public final void setIncludeStandardMetadataSignatures(boolean value)

Gets or sets flag to include into the Metadata List the embedded standard document metadata signatures like Author, Owner, document creation date, modified date, etc. If this flag is set to false (by default) the GetDocumentInfo will not include these metadata signatures. When this flag is set to true the document information will include these standard metadata signatures.

setLogLevel

public final void setLogLevel(int value)

The level of the logging to limit the messages (All, Traces, Warnings, Errors). LogLevel. BY default the All level type is set.

setSaveDocumentOnEmptyDelete

public final void setSaveDocumentOnEmptyDelete(boolean value)

Gets or sets flag to resave source document when Delete method has no affected signatures to remove. If this flag is set to true (by default) document will be saving with corresponding history process log (date and operation type) even if Delete method has no signatures to remove. When this flat is set to false source document will not be modified at all.

setSaveDocumentOnEmptyUpdate

public final void setSaveDocumentOnEmptyUpdate(boolean value)

Gets or sets flag to resave source document when Update method has no signatures to update. If this flag is set to true (by default) document will be saving with corresponding history process log (date and operation type) even if Update method has no signatures to update. When this flat is set to false source document will not be modified at all.

setShowDeletedSiganturesInfo

public final void setShowDeletedSiganturesInfo(boolean value)

Gets or sets flag that includes deleted signatures into Document Info result. Each Signature BaseSignature has Deleted flag BaseSignature.Deleted(BaseSignature.getDeleted()/BaseSignature.setDeleted(boolean)) to detect if it was deleted.