com.silanis.esl.sdk.builder

Class ReminderScheduleBuilder

java.lang.Object

com.silanis.esl.sdk.builder.ReminderScheduleBuilder

public class ReminderScheduleBuilder
extends Object

Helper class useful to define the schedule at which reminder emails will be sent out to signer who have not yet completed signing a given package.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_DAYS_BETWEEN_REMINDERS
static int	DEFAULT_DAYS_UNTIL_FIRST_REMINDER
static int	DEFAULT_NUMBER_OF_REPETITIONS

Method Summary

Modifier and Type	Method and Description
ReminderSchedule	build() Builds the actual ReminderSchedule with the values specified.
static ReminderScheduleBuilder	forPackageWithId(PackageId packageId) Defines a new email reminder schedule for a given package.
static ReminderScheduleBuilder	forPackageWithId(String packageId) Defines a new email reminder schedule for a given package.
ReminderScheduleBuilder	withDaysBetweenReminders(int daysBetweenReminders) Set the number of days between sending of reminders.
ReminderScheduleBuilder	withDaysUntilFirstReminder(int daysUntilFirstReminder) Set the number of days after the package is created and its status is set to SENT when the first email reminder should be sent to signers who have not completed signing their documents.
ReminderScheduleBuilder	withNumberOfRepetitions(int numberOfRepetitions) Set the maximum number of reminders that should be sent if a signer has not completed his signing process.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DAYS_UNTIL_FIRST_REMINDER

public static final int DEFAULT_DAYS_UNTIL_FIRST_REMINDER

See Also:

Constant Field Values

DEFAULT_DAYS_BETWEEN_REMINDERS

public static final int DEFAULT_DAYS_BETWEEN_REMINDERS

See Also:

Constant Field Values

DEFAULT_NUMBER_OF_REPETITIONS

public static final int DEFAULT_NUMBER_OF_REPETITIONS

See Also:

Constant Field Values

Method Detail

forPackageWithId

public static ReminderScheduleBuilder forPackageWithId(String packageId)

Defines a new email reminder schedule for a given package.

Parameters:

packageId - id of the package for which to apply the reminder schedule.

Returns:

forPackageWithId

public static ReminderScheduleBuilder forPackageWithId(PackageId packageId)

Defines a new email reminder schedule for a given package.

Parameters:

packageId - id of the package for which to apply the reminder schedule.

Returns:

See Also:

ReminderScheduleBuilder(PackageId)

withDaysUntilFirstReminder

public ReminderScheduleBuilder withDaysUntilFirstReminder(int daysUntilFirstReminder)

Set the number of days after the package is created and its status is set to SENT when the first email reminder should be sent to signers who have not completed signing their documents.

Parameters:

daysUntilFirstReminder - @min="1" @max="65535"

Returns:

withDaysBetweenReminders

public ReminderScheduleBuilder withDaysBetweenReminders(int daysBetweenReminders)

Set the number of days between sending of reminders.

Parameters:

daysBetweenReminders - @min="1"" @max="65535"

Returns:

withNumberOfRepetitions

public ReminderScheduleBuilder withNumberOfRepetitions(int numberOfRepetitions)

Set the maximum number of reminders that should be sent if a signer has not completed his signing process.

Parameters:

numberOfRepetitions - @min="1"" @max="65535"

Returns:

build

public ReminderSchedule build()

Builds the actual ReminderSchedule with the values specified.

Returns: