com.silanis.esl.sdk.builder

Class GroupBuilder

java.lang.Object

com.silanis.esl.sdk.builder.GroupBuilder

public class GroupBuilder
extends Object

GroupBuilder is a convenient class to used to define groups of senders for a given eSignLive account.

Method Summary

Modifier and Type	Method and Description
Group	build() Builds the group object.
GroupBuilder	createdOn(Date created) Deprecated.
static GroupBuilder	newGroup(String name) Instantiate a new Group of senders.
GroupBuilder	updatedOn(Date updated) Deprecated.
GroupBuilder	withEmail(String email) Set this group email's address.
GroupBuilder	withId(GroupId groupId) Defines a unique ID for this group.
GroupBuilder	withIndividualMemberEmailing() When setting this method, eSignLive will email each individual members of the group as opposed to sending an email to the group email address.
GroupBuilder	withMember(GroupMember groupMember) Adds a sender to the group.
GroupBuilder	withMember(GroupMemberBuilder builder) Adds a sender to the group.
GroupBuilder	withoutIndividualMemberEmailing() Invoking this method will result in eSignLive sending emails to the group email withEmail(String) address as opposed to each individual members.

Methods inherited from class java.lang.Object

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

Method Detail

newGroup

public static GroupBuilder newGroup(String name)

Instantiate a new Group of senders.

Parameters:

name - name of the new group @size(max="255")

Returns:

the group builder itself

withEmail

public GroupBuilder withEmail(String email)

Set this group email's address.

Parameters:

email - @size(min="6" max="255")

Returns:

the group builder itself

createdOn

public GroupBuilder createdOn(Date created)

Deprecated.

Set the date the group was created.

Parameters:

created -

Returns:

the group builder itself

updatedOn

public GroupBuilder updatedOn(Date updated)

Deprecated.

Set the date the group was updated on.

Parameters:

updated -

Returns:

the group builder itself

withIndividualMemberEmailing

public GroupBuilder withIndividualMemberEmailing()

When setting this method, eSignLive will email each individual members of the group as opposed to sending an email to the group email address.

Returns:

the group builder itself

See Also:

withEmail(String)

withoutIndividualMemberEmailing

public GroupBuilder withoutIndividualMemberEmailing()

Invoking this method will result in eSignLive sending emails to the group email withEmail(String) address as opposed to each individual members.

Returns:

the group builder itself

See Also:

withIndividualMemberEmailing()

withMember

public GroupBuilder withMember(GroupMemberBuilder builder)

Adds a sender to the group.

Parameters:

builder - the group member builder

Returns:

the group builder itself

withMember

public GroupBuilder withMember(GroupMember groupMember)

Adds a sender to the group.

Parameters:

groupMember - the group member

Returns:

the group builder itself

build

public Group build()

Builds the group object.

Returns:

the group

withId

public GroupBuilder withId(GroupId groupId)

Defines a unique ID for this group. E.g.: Two groups can have the same name but they MUST have different IDs.

Parameters:

groupId - the group ID

Returns:

the group builder itself