com.silanis.esl.sdk.builder

Class DocumentPackageSettingsBuilder

java.lang.Object

com.silanis.esl.sdk.builder.DocumentPackageSettingsBuilder

public class DocumentPackageSettingsBuilder
extends Object

Builder object used to customize the signing ceremony.

This object allows to customize the signing ceremony with certain UI widgets of customization options.

See Also:

Customizing the Signing Ceremony [e-Sign Enterprise Documentation Project]

Method Summary

Methods

Modifier and Type	Method and Description
DocumentPackageSettings	build() Builds the actual Field with the values specified.
DocumentPackageSettingsBuilder	disableFirstAffidavit()
DocumentPackageSettingsBuilder	disableSecondAffidavit()
DocumentPackageSettingsBuilder	enableFirstAffidavit()
DocumentPackageSettingsBuilder	enableSecondAffidavit()
DocumentPackageSettingsBuilder	hideOwnerInPersonDropDown() Removes the owner of the package from the list of users, when switching users during an inPerson signing ceremony.
static DocumentPackageSettingsBuilder	newDocumentPackageSettings()
DocumentPackageSettingsBuilder	showOwnerInPersonDropDown() Displays the owner int the list of users, when switching users during an inPerson signing ceremony.
DocumentPackageSettingsBuilder	withCeremonyLayoutSettings(CeremonyLayoutSettings ceremonyLayoutSettings) Set e-SignLive signing ceremony branding and customization options.
DocumentPackageSettingsBuilder	withCeremonyLayoutSettings(CeremonyLayoutSettingsBuilder ceremonyLayoutSettingsBuilder) Set e-SignLive signing ceremony branding and customization options.
DocumentPackageSettingsBuilder	withDecline() Enables the option for a signer to decline the signing ceremony as a whole.
DocumentPackageSettingsBuilder	withDialogOnComplete() Enables displaying the completion dialog, which asks the users whether they want to review the documents or leave the system, is shown to the signer after completing the signing ceremony.
DocumentPackageSettingsBuilder	withDocumentToolbarDownloadButton() Display a download button with a link to download the document in the toolbar above the document when all the signatures are completed
DocumentPackageSettingsBuilder	withHandOverLinkHref(String href) Enables adding a link on the signing ceremony page where the user will be sent after being shown the completion dialog box.
DocumentPackageSettingsBuilder	withHandOverLinkText(String text) Set the text to be displayed for the @see #withHandOverLinkHref.
DocumentPackageSettingsBuilder	withHandOverLinkTooltip(String tooltip) Set the text to be displayed for the @see #withHandOverLinkHref tool tip when the user over with the mouse over the handoverlink href.
DocumentPackageSettingsBuilder	withInPerson() Enables the participating signer to be changed during the signing ceremony without resorting to emails or clicking on links.
DocumentPackageSettingsBuilder	withLanguageDropDown()
DocumentPackageSettingsBuilder	withOptOut() Enables the option for a signer to decline signing electronically.
DocumentPackageSettingsBuilder	withOptOutReason(String reason) Set a reason text that will be displayed to the signer when they click on the opt-out button, if this button is enabled.
DocumentPackageSettingsBuilder	withoutCaptureText() Disables the stamping documents with the date, time, and signer's name at each location they were signed.
DocumentPackageSettingsBuilder	withoutDecline() Disables the option for a signer to decline the signing ceremony as a whole.
DocumentPackageSettingsBuilder	withoutDialogOnComplete() Disables displaying the completion dialog after completing the signing ceremony.
DocumentPackageSettingsBuilder	withoutDocumentToolbarDownloadButton() Removes the download link that appears after the signer completed the signing ceremony
DocumentPackageSettingsBuilder	withoutInPerson() Disables switching signer during the same signature session.
DocumentPackageSettingsBuilder	withoutLanguageDropDown()
DocumentPackageSettingsBuilder	withoutOptOut() Disables the option for a signer to decline signing electronically.
DocumentPackageSettingsBuilder	withoutWatermark() Disables the option to stamp the signed documents with the e-SignLive logo at each location they were signed.
DocumentPackageSettingsBuilder	withWatermark() Enables the option to stamp the signed documents with the e-SignLive logo at each location they were signed.

Methods inherited from class java.lang.Object

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

Method Detail

newDocumentPackageSettings

public static DocumentPackageSettingsBuilder newDocumentPackageSettings()

showOwnerInPersonDropDown

public DocumentPackageSettingsBuilder showOwnerInPersonDropDown()

Displays the owner int the list of users, when switching users during an inPerson signing ceremony.

Returns:

This

hideOwnerInPersonDropDown

public DocumentPackageSettingsBuilder hideOwnerInPersonDropDown()

Removes the owner of the package from the list of users, when switching users during an inPerson signing ceremony.

withLanguageDropDown

public DocumentPackageSettingsBuilder withLanguageDropDown()

withoutLanguageDropDown

public DocumentPackageSettingsBuilder withoutLanguageDropDown()

enableFirstAffidavit

public DocumentPackageSettingsBuilder enableFirstAffidavit()

disableFirstAffidavit

public DocumentPackageSettingsBuilder disableFirstAffidavit()

enableSecondAffidavit

public DocumentPackageSettingsBuilder enableSecondAffidavit()

disableSecondAffidavit

public DocumentPackageSettingsBuilder disableSecondAffidavit()

withDialogOnComplete

public DocumentPackageSettingsBuilder withDialogOnComplete()

Enables displaying the completion dialog, which asks the users whether they want to review the documents or leave the system, is shown to the signer after completing the signing ceremony.

DEFAULT: ENABLED

Returns:

This

withoutDialogOnComplete

public DocumentPackageSettingsBuilder withoutDialogOnComplete()

Disables displaying the completion dialog after completing the signing ceremony.

Returns:

This

See Also:

withDialogOnComplete()

withInPerson

public DocumentPackageSettingsBuilder withInPerson()

Enables the participating signer to be changed during the signing ceremony without resorting to emails or clicking on links. This setting is typically used when two or more signers (e.g.: an Agent and a customer, for example) share the same device (e.g.: the Agent's computer) to sign a document.

DEFAULT: ENABLED

Returns:

This

withoutInPerson

public DocumentPackageSettingsBuilder withoutInPerson()

Disables switching signer during the same signature session.

Returns:

This

See Also:

withInPerson()

withOptOut

public DocumentPackageSettingsBuilder withOptOut()

Enables the option for a signer to decline signing electronically.

DEFAULT: ENABLED

Returns:

This

withoutOptOut

public DocumentPackageSettingsBuilder withoutOptOut()

Disables the option for a signer to decline signing electronically.

Returns:

This

See Also:

withOptOut()

withDecline

public DocumentPackageSettingsBuilder withDecline()

Enables the option for a signer to decline the signing ceremony as a whole.

DEFAULT: ENABLED

Returns:

This

withoutDecline

public DocumentPackageSettingsBuilder withoutDecline()

Disables the option for a signer to decline the signing ceremony as a whole.

Returns:

This

See Also:

withDecline()

withWatermark

public DocumentPackageSettingsBuilder withWatermark()

Enables the option to stamp the signed documents with the e-SignLive logo at each location they were signed.

DEFAULT: ENABLED

Returns:

This

withoutWatermark

public DocumentPackageSettingsBuilder withoutWatermark()

Disables the option to stamp the signed documents with the e-SignLive logo at each location they were signed.

Returns:

This

See Also:

withWatermark()

withoutCaptureText

public DocumentPackageSettingsBuilder withoutCaptureText()

Disables the stamping documents with the date, time, and signer's name at each location they were signed.

DEFAULT: DISABLED

Returns:

This

withHandOverLinkHref

public DocumentPackageSettingsBuilder withHandOverLinkHref(String href)

Enables adding a link on the signing ceremony page where the user will be sent after being shown the completion dialog box. Replaces the continue button during the signing ceremony. Use the LinkBuilder class to create one.

DEFAULT: DISABLED

Parameters:

href - URL to where the user will be redirected upon clicking on the link. @size(max="255")

Returns:

This

withHandOverLinkText

public DocumentPackageSettingsBuilder withHandOverLinkText(String text)

Set the text to be displayed for the @see #withHandOverLinkHref.

DEFAULT: DISABLED

Parameters:

text - text displayed to represent the handoverlink href on the e-SignLive UI. @size(max="255")

Returns:

This

See Also:

withHandOverLinkHref(String)

withHandOverLinkTooltip

public DocumentPackageSettingsBuilder withHandOverLinkTooltip(String tooltip)

Set the text to be displayed for the @see #withHandOverLinkHref tool tip when the user over with the mouse over the handoverlink href.

DEFAULT: DISABLED

Parameters:

tooltip - text displayed to represent the handoverlink href tool tip on the e-SignLive UI. @size(max="255")

Returns:

This

See Also:

withHandOverLinkHref(String)

withCeremonyLayoutSettings

public DocumentPackageSettingsBuilder withCeremonyLayoutSettings(CeremonyLayoutSettingsBuilder ceremonyLayoutSettingsBuilder)

Set e-SignLive signing ceremony branding and customization options.

Parameters:

ceremonyLayoutSettingsBuilder -

Returns:

This

withCeremonyLayoutSettings

public DocumentPackageSettingsBuilder withCeremonyLayoutSettings(CeremonyLayoutSettings ceremonyLayoutSettings)

Set e-SignLive signing ceremony branding and customization options.

Parameters:

ceremonyLayoutSettings -

Returns:

This

build

public DocumentPackageSettings build()

Builds the actual Field with the values specified.

Returns:

the built DocumentPackageSettings

withOptOutReason

public DocumentPackageSettingsBuilder withOptOutReason(String reason)

Set a reason text that will be displayed to the signer when they click on the opt-out button, if this button is enabled. There can be multiple reasons and this method can be invoked multiple times to add different reasons.

Parameters:

reason - @size(max="255")

Returns:

This

See Also:

withOptOut()

withDocumentToolbarDownloadButton

public DocumentPackageSettingsBuilder withDocumentToolbarDownloadButton()

Display a download button with a link to download the document in the toolbar above the document when all the signatures are completed

DEFAULT: ENABLED

Returns:

This

withoutDocumentToolbarDownloadButton

public DocumentPackageSettingsBuilder withoutDocumentToolbarDownloadButton()

Removes the download link that appears after the signer completed the signing ceremony

Returns:

This

See Also:

withDocumentToolbarDownloadButton()