SignatureSettings Leave feedback
On this page
Inheritance: java.lang.Object
public class SignatureSettings
Defines settings for customizing Signature behavior.
| Constructor | Description |
|---|---|
| SignatureSettings() | Creates default SignatureSettings instance with default values. |
| SignatureSettings(ILogger logger) | Creates default SignatureSettings instance with the Logger implementation. |
| Method | Description |
|---|---|
| getDefaultCulture() | Gets or sets default culture to be used during document processing. |
| setDefaultCulture(Locale value) | Gets or sets default culture to be used during document processing. |
| getShowDeletedSiganturesInfo() | Gets or sets flag that includes deleted signatures into Document Info result. |
| setShowDeletedSiganturesInfo(boolean value) | Gets or sets flag that includes deleted signatures into Document Info result. |
| getSaveDocumentOnEmptyUpdate() | Gets or sets flag to resave source document when Update method has no signatures to update. |
| setSaveDocumentOnEmptyUpdate(boolean value) | Gets or sets flag to resave source document when Update method has no signatures to update. |
| getSaveDocumentOnEmptyDelete() | Gets or sets flag to resave source document when Delete method has no affected signatures to remove. |
| setSaveDocumentOnEmptyDelete(boolean value) | Gets or sets flag to resave source document when Delete method has no affected signatures to remove. |
| 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. |
| 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. |
| getLogger() | The logger implementation used for logging (Errors, Warnings, Traces). |
| getLogLevel() | Gets or sets which kinds of messages are passed to the logger. |
| setLogLevel(int value) | Gets or sets which kinds of messages are passed to the logger. |
public SignatureSettings()
Creates default SignatureSettings instance with default values.
public SignatureSettings(ILogger logger)
Creates default SignatureSettings instance with the Logger implementation.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| logger | ILogger |
public static Locale getDefaultCulture()
Gets or sets default culture to be used during document processing. Default value is “en-US”.
Returns: java.util.Locale
public final void setDefaultCulture(Locale value)
Gets or sets default culture to be used during document processing. Default value is “en-US”.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.util.Locale |
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.
Returns: boolean
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
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.
Returns: boolean
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
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.
Returns: boolean
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
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.
Returns: boolean
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
public final ILogger getLogger()
The logger implementation used for logging (Errors, Warnings, Traces). ILogger.
Returns: ILogger
public final int getLogLevel()
Gets or sets which kinds of messages are passed to the logger. The value is a set of LogLevel flags that can be combined, for example
- LogLevel.Error | LogLevel.Warning
- .
- LogLevel.None
- logs nothing.
- The default is
- LogLevel.All
- errors, warnings and traces.
Returns: int
public final void setLogLevel(int value)
Gets or sets which kinds of messages are passed to the logger. The value is a set of LogLevel flags that can be combined, for example
- LogLevel.Error | LogLevel.Warning
- .
- LogLevel.None
- logs nothing.
- The default is
- LogLevel.All
- errors, warnings and traces.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.
