com.silanis.esl.sdk.builder

Class PackageBuilder

java.lang.Object

com.silanis.esl.sdk.builder.PackageBuilder

public class PackageBuilder
extends Object

PackageBuilder is a convenient class used to create and customize a package.

Constructor Summary

Constructors

Constructor and Description
PackageBuilder(String packageName) The constructor of the PackageBuilder class.

Method Summary

Modifier and Type	Method and Description
PackageBuilder	autocomplete(boolean autocomplete) Sets the autocomplete package property.
DocumentPackage	build() Builds the actual document package.
PackageBuilder	describedAs(String description) Sets the description for the package.
PackageBuilder	expiresAt(Date expiryDate) Sets the expiration date for the package.
static PackageBuilder	newPackageNamed(String name) Creates a package having the package name set to the value of the name parameter.
PackageBuilder	withAttributes(DocumentPackageAttributes attributes) Sets the customized attributes for the package.
PackageBuilder	withAttributes(DocumentPackageAttributesBuilder builder) Sets the customized attributes for the package.
PackageBuilder	withCondition(FieldCondition condition) Sets the condition for the package field.
PackageBuilder	withDocument(Document document) Adds a document to the package.
PackageBuilder	withDocument(DocumentBuilder builder) Adds a document to the package.
PackageBuilder	withEmailMessage(String packageMessage) Adds an email message which will be sent to all the signers in the package.
PackageBuilder	withID(PackageId id) Deprecated. Please do not use withID() from now on. Will get deleted in a future release
PackageBuilder	withLanguage(Locale language) Set the default package language.
PackageBuilder	withNotarized(Boolean notarized)
PackageBuilder	withOrigin(String origin) Sets the origin for the package.
PackageBuilder	withSenderInfo(SenderInfo senderInfo) Set information about the package sender user.
PackageBuilder	withSenderInfo(SenderInfoBuilder senderInfoBuilder) Set information about the package sender user.
PackageBuilder	withSettings(DocumentPackageSettings settings) Set the package configuration options such as options to opt-out, decline, watermark, etc...
PackageBuilder	withSettings(DocumentPackageSettingsBuilder builder) Set the package configuration options such as options to opt-out, decline, watermark, etc...
PackageBuilder	withSigner(Signer signer) Adds a signer to the package.
PackageBuilder	withSigner(SignerBuilder builder) Adds a signer to the package.
PackageBuilder	withStatus(PackageStatus status) Sets the status package property.
PackageBuilder	withTimezoneId(String timezoneId)
PackageBuilder	withTrashed(Boolean trashed)
PackageBuilder	withVisibility(Visibility visibility)

Methods inherited from class java.lang.Object

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

Constructor Detail

PackageBuilder

public PackageBuilder(String packageName)

The constructor of the PackageBuilder class.

Parameters:

packageName - the name of the package @size(min="1", max="255")

Method Detail

newPackageNamed

public static PackageBuilder newPackageNamed(String name)

Creates a package having the package name set to the value of the name parameter.

Parameters:

name - the package name @size(min="1", max="255")

Returns:

a package builder

withID

@Deprecated
public PackageBuilder withID(PackageId id)

Deprecated. Please do not use withID() from now on. Will get deleted in a future release

Parameters:

id -

Returns:

the package builder itself

withSigner

public PackageBuilder withSigner(SignerBuilder builder)

Adds a signer to the package. The signer is conveniently customized by the builder provided as parameter.

Parameters:

builder - the signer builder

Returns:

the package builder itself

withSigner

public PackageBuilder withSigner(Signer signer)

Adds a signer to the package.

Parameters:

signer - a signer that signs one or more documents belonging to the package

Returns:

the package builder itself

withDocument

public PackageBuilder withDocument(DocumentBuilder builder)

Adds a document to the package. The document is conveniently customized by the builder provided as parameter.

Parameters:

builder - a document builder

Returns:

the package builder itself

withDocument

public PackageBuilder withDocument(Document document)

Adds a document to the package.

Parameters:

document - the new document

Returns:

the package builder itself

withNotarized

public PackageBuilder withNotarized(Boolean notarized)

withTrashed

public PackageBuilder withTrashed(Boolean trashed)

withVisibility

public PackageBuilder withVisibility(Visibility visibility)

withTimezoneId

public PackageBuilder withTimezoneId(String timezoneId)

build

public DocumentPackage build()

Builds the actual document package.

Returns:

the document package

autocomplete

public PackageBuilder autocomplete(boolean autocomplete)

Sets the autocomplete package property. When set to true, the package is automatically marked as complete once all the signature fields are signed. When set to false, the sender needs to manually mark the package as complete.

By default, autocomplete is set to true.

Parameters:

autocomplete -

Returns:

the package builder itself

withStatus

public PackageBuilder withStatus(PackageStatus status)

Sets the status package property.

Parameters:

status - the package status

Returns:

the package builder itself

describedAs

public PackageBuilder describedAs(String description)

Sets the description for the package.

Parameters:

description - package textual description @size(min="0", max="255")

Returns:

the package builder itself

expiresAt

public PackageBuilder expiresAt(Date expiryDate)

Sets the expiration date for the package.

Parameters:

expiryDate - the package's expiration date

Returns:

the package builder itself

withEmailMessage

public PackageBuilder withEmailMessage(String packageMessage)

Adds an email message which will be sent to all the signers in the package.

Parameters:

packageMessage - the email message @size(max="255")

Returns:

the package builder itself

withSettings

public PackageBuilder withSettings(DocumentPackageSettingsBuilder builder)

Set the package configuration options such as options to opt-out, decline, watermark, etc...

Parameters:

builder - the document package settings builder

Returns:

the package builder itself

See Also:

withSettings(DocumentPackageSettingsBuilder)

withSettings

public PackageBuilder withSettings(DocumentPackageSettings settings)

Set the package configuration options such as options to opt-out, decline, watermark, etc...

Parameters:

settings -

Returns:

the package builder itself

See Also:

withSettings(DocumentPackageSettingsBuilder)

withLanguage

public PackageBuilder withLanguage(Locale language)

Set the default package language. It defines the default language in which the UI will be presented to the signers.

Parameters:

language - default language the UI will present the information.

Returns:

the package builder itself

withSenderInfo

public PackageBuilder withSenderInfo(SenderInfoBuilder senderInfoBuilder)

Set information about the package sender user.

Parameters:

senderInfoBuilder - package sender user information

Returns:

the package builder itself

withSenderInfo

public PackageBuilder withSenderInfo(SenderInfo senderInfo)

Set information about the package sender user.

Parameters:

senderInfo - package sender user information

Returns:

the package builder itself

See Also:

withSenderInfo(SenderInfoBuilder)

withAttributes

public PackageBuilder withAttributes(DocumentPackageAttributes attributes)

Sets the customized attributes for the package. Attributes are key/value pairs of user defined information. It can be anything.

Parameters:

attributes - the document attributes

Returns:

the package builder itself

See Also:

withAttributes(DocumentPackageAttributesBuilder)

withAttributes

public PackageBuilder withAttributes(DocumentPackageAttributesBuilder builder)

Sets the customized attributes for the package. Attributes are key/value pairs of user defined information. It can be anything.

E.g.: animal = cat

Parameters:

builder - the document package attributes builder

Returns:

the package builder itself

See Also:

withAttributes(DocumentPackageAttributesBuilder)

withOrigin

public PackageBuilder withOrigin(String origin)

Sets the origin for the package. It can be the origin information.

Parameters:

origin - the origin information

Returns:

the package builder itself

withCondition

public PackageBuilder withCondition(FieldCondition condition)

Sets the condition for the package field.

Parameters:

condition - field condition

Returns:

the package builder itself