com.silanis.esl.sdk.builder.PackageBuilder Maven / Gradle / Ivy
package com.silanis.esl.sdk.builder;
import com.silanis.esl.sdk.*;
import java.util.*;
/**
* PackageBuilder is a convenient class used to create and customize a package.
*/
public class PackageBuilder {
private final String packageName;
private final List signers = new ArrayList();
private final List placeholders = new ArrayList();
private List documents = new ArrayList();
private boolean autocomplete = true;
private String description = null;
private Date expiryDate;
private String packageMessage = null;
private Boolean notarized;
private Boolean trashed;
private PackageId id;
private PackageStatus status;
private DocumentPackageSettings settings;
private Locale language;
private SenderInfo senderInfo = null;
private DocumentPackageAttributes attributes;
private Visibility visibility;
private String timezoneId;
private final List conditions = new ArrayList();
private static final String ORIGIN_KEY = "origin";
/**
* The constructor of the PackageBuilder class.
*
* @param packageName the name of the package @size(min="1", max="255")
*/
public PackageBuilder( String packageName ) {
this.packageName = packageName;
}
/**
* Creates a package having the package name set to the value of the name parameter.
*
* @param name the package name @size(min="1", max="255")
* @return a package builder
*/
public static PackageBuilder newPackageNamed( String name ) {
return new PackageBuilder( name );
}
/**
* @param id
* @return the package builder itself
* @deprecated Please do not use withID() from now on. Will get deleted in a future release
*/
@Deprecated
public PackageBuilder withID( PackageId id ) {
this.id = id;
return this;
}
/**
* Adds a signer to the package. The signer is conveniently customized by the builder provided as parameter.
*
* @param builder the signer builder
* @return the package builder itself
*/
public PackageBuilder withSigner( SignerBuilder builder ) {
return withSigner( builder.build() );
}
/**
* Adds a signer to the package.
*
* @param signer a signer that signs one or more documents belonging to the package
* @return the package builder itself
*/
public PackageBuilder withSigner( Signer signer ) {
if(signer.isPlaceholderSigner()){
placeholders.add(signer);
} else {
signers.add(signer);
}
return this;
}
/**
* Adds a document to the package. The document is conveniently customized by the builder provided as parameter.
*
* @param builder a document builder
* @return the package builder itself
*/
public PackageBuilder withDocument( DocumentBuilder builder ) {
return withDocument( builder.build() );
}
/**
* Adds a document to the package.
*
* @param document the new document
* @return the package builder itself
*/
public PackageBuilder withDocument( Document document ) {
addDocument( document );
return this;
}
public PackageBuilder withNotarized( Boolean notarized ) {
this.notarized = notarized;
return this;
}
public PackageBuilder withTrashed( Boolean trashed ) {
this.trashed = trashed;
return this;
}
public PackageBuilder withVisibility( Visibility visibility) {
this.visibility = visibility;
return this;
}
public PackageBuilder withTimezoneId( String timezoneId ) {
this.timezoneId = timezoneId;
return this;
}
/**
* Builds the actual document package.
*
* @return the document package
*/
public DocumentPackage build() {
DocumentPackage documentPackage = new DocumentPackage( packageName, signers, placeholders, documents, autocomplete );
documentPackage.setExpiryDate( expiryDate );
documentPackage.setId( id );
documentPackage.setStatus( status );
documentPackage.setSenderInfo( senderInfo );
documentPackage.setAttributes(attributes);
if ( language != null ) {
documentPackage.setLanguage( language );
}
if ( settings != null ) {
documentPackage.setSettings(settings);
}
if ( description != null ) {
documentPackage.setDescription(description);
}
if ( packageMessage != null ) {
documentPackage.setPackageMessage(packageMessage);
}
if ( notarized != null ) {
documentPackage.setNotarized(notarized);
}
if ( trashed != null ) {
documentPackage.setTrashed(trashed);
}
if ( visibility != null ) {
documentPackage.setVisibility(visibility);
}
if ( timezoneId != null ) {
documentPackage.setTimezoneId(timezoneId);
}
if (conditions != null && !conditions.isEmpty()) {
documentPackage.setConditions(conditions);
}
return documentPackage;
}
/**
* Adds a new document to the package.
*
* @param document the new document
*/
private void addDocument(Document document) {
documents.add(document);
}
/**
* 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.
*
* @param autocomplete
* @return the package builder itself
*/
public PackageBuilder autocomplete( boolean autocomplete ) {
this.autocomplete = autocomplete;
return this;
}
/**
* Sets the status package property.
*
* @param status the package status
* @return the package builder itself
*/
public PackageBuilder withStatus( PackageStatus status ) {
this.status = status;
return this;
}
/**
* Sets the description for the package.
*
* @param description package textual description @size(min="0", max="255")
* @return the package builder itself
*/
public PackageBuilder describedAs( String description ) {
this.description = description;
return this;
}
/**
* Sets the expiration date for the package.
*
* @param expiryDate the package's expiration date
* @return the package builder itself
*/
public PackageBuilder expiresAt( Date expiryDate ) {
this.expiryDate = expiryDate;
return this;
}
/**
*
Adds an email message which will be sent to all the signers in the package.
*
* @param packageMessage the email message @size(max="255")
* @return the package builder itself
*/
public PackageBuilder withEmailMessage( String packageMessage ) {
this.packageMessage = packageMessage;
return this;
}
/**
* Set the package configuration options such as options to opt-out, decline, watermark, etc...
*
* @see #withSettings(DocumentPackageSettingsBuilder)
* @param builder the document package settings builder
* @return the package builder itself
*/
public PackageBuilder withSettings( DocumentPackageSettingsBuilder builder ) {
return withSettings( builder.build() );
}
/**
* Set the package configuration options such as options to opt-out, decline, watermark, etc...
*
* @see #withSettings(DocumentPackageSettingsBuilder)
* @param settings
* @return the package builder itself
*/
public PackageBuilder withSettings( DocumentPackageSettings settings ) {
this.settings = settings;
return this;
}
/**
* Set the default package language. It defines the default language in which the UI will be
* presented to the signers.
*
* @param language default language the UI will present the information.
* @return the package builder itself
*/
public PackageBuilder withLanguage( Locale language ) {
this.language = language;
return this;
}
/**
* Set information about the package sender user.
*
* @param senderInfoBuilder package sender user information
* @return the package builder itself
*/
public PackageBuilder withSenderInfo( SenderInfoBuilder senderInfoBuilder ) {
return withSenderInfo( senderInfoBuilder.build() );
}
/**
* Set information about the package sender user.
*
* @see #withSenderInfo(SenderInfoBuilder)
* @param senderInfo package sender user information
* @return the package builder itself
*/
public PackageBuilder withSenderInfo( SenderInfo senderInfo ) {
this.senderInfo = senderInfo;
return this;
}
/**
* Sets the customized attributes for the package. Attributes are key/value pairs of user defined information.
* It can be anything.
*
* @see #withAttributes(DocumentPackageAttributesBuilder)
* @param attributes the document attributes
* @return the package builder itself
*/
public PackageBuilder withAttributes( DocumentPackageAttributes attributes ) {
if(null == this.attributes) {
this.attributes = new DocumentPackageAttributes();
}
this.attributes.append(attributes);
return this;
}
/**
* Sets the customized attributes for the package. Attributes are key/value pairs of user defined information.
* It can be anything.
*
* E.g.: animal = cat
*
* @see #withAttributes(DocumentPackageAttributesBuilder)
* @param builder the document package attributes builder
* @return the package builder itself
*/
public PackageBuilder withAttributes( DocumentPackageAttributesBuilder builder) {
return withAttributes( builder.build() );
}
/**
* Sets the origin for the package.
* It can be the origin information.
*
* @param origin the origin information
* @return the package builder itself
*/
public PackageBuilder withOrigin( String origin ) {
if(null == this.attributes) {
this.attributes = new DocumentPackageAttributes();
}
this.attributes.append(ORIGIN_KEY, origin);
return this;
}
/**
* Sets the condition for the package field.
*
* @param condition field condition
* @return the package builder itself
*/
public PackageBuilder withCondition( FieldCondition condition) {
this.conditions.add(condition);
return this;
}
}