Package com.axemble.vdoc.sdk.interfaces.notification

Interface INotificationRecipientBuilder

public interface INotificationRecipientBuilder

Builder tool used to produce notification recipient.

A builder instance can only produce one recipient instance safely. So, to produce multiple recipient instance you need to retrieve multiple builder instances.

Method Summary

Modifier and Type	Method	Description
INotificationRecipient	build()	Produces a notification recipient with the information previously fed using "with..." methods
INotificationRecipientBuilder	withEmail(String email)	Feeds the e-mail and returns the builder
INotificationRecipientBuilder	withExternalID(String externalID)	Feeds the externalID and returns the builder
INotificationRecipientBuilder	withFirstName(String firstName)	Feeds the firstName and returns the builder
INotificationRecipientBuilder	withFullName(String fullName)	Feeds the fullName and returns the builder
INotificationRecipientBuilder	withIUser(IUser iUser)	Feeds every data that can be found in the IUser and returns the builder
INotificationRecipientBuilder	withIUserProtocolURI(String iUserProtocolURI)	Feeds the IUser's protocolURI and returns the builder
INotificationRecipientBuilder	withLanguageCode(String languageCode)	Feeds the languageCode and returns the builder
INotificationRecipientBuilder	withLastName(String lastName)	Feeds the lastName and returns the builder
INotificationRecipientBuilder	withLogin(String login)	Feeds the login and returns the builder
INotificationRecipientBuilder	withMobilePhoneNumber(String mobilePhoneNumber)	Feeds the mobile phone number and returns the builder
INotificationRecipientBuilder	withPhoneNumber(String phoneNumber)	Feeds the phone number and returns the builder
INotificationRecipientBuilder	withSex(String sex)	Feeds the sex and returns the builder
INotificationRecipientBuilder	withTitle(String title)	Feeds the title and returns the builder

Method Details

withFirstName

INotificationRecipientBuilder withFirstName(String firstName)

Feeds the firstName and returns the builder

Parameters:

firstName - the firstName to feed

Returns:

the builder

Throws:

IllegalArgumentException - - if firstName is null or blank

withLastName

INotificationRecipientBuilder withLastName(String lastName)

Feeds the lastName and returns the builder

Parameters:

lastName - the lastName to feed

Returns:

the builder

Throws:

IllegalArgumentException - - if lastName is null or blank

withFullName

INotificationRecipientBuilder withFullName(String fullName)

Feeds the fullName and returns the builder

Parameters:

fullName - the fullName to feed

Returns:

the builder

Throws:

IllegalArgumentException - - if fullName is null or blank

withTitle

INotificationRecipientBuilder withTitle(String title)

Feeds the title and returns the builder

Parameters:

title - the title to feed

Returns:

the builder

Throws:

IllegalArgumentException - - if title is null or blank

withSex

INotificationRecipientBuilder withSex(String sex)

Feeds the sex and returns the builder

Parameters:

sex - the sex to feed

Returns:

the builder

Throws:

IllegalArgumentException - - if sex is null or blank

withIUserProtocolURI

INotificationRecipientBuilder withIUserProtocolURI(String iUserProtocolURI)

Feeds the IUser's protocolURI and returns the builder

Parameters:

iUserProtocolURI - the IUser's protocolURI to feed

Returns:

the builder

Throws:

IllegalArgumentException - - if iUserProtocolURI is null or blank

withLogin

INotificationRecipientBuilder withLogin(String login)

Feeds the login and returns the builder

Parameters:

login - the login to feed

Returns:

the builder

Throws:

IllegalArgumentException - - if login is null or blank

withExternalID

INotificationRecipientBuilder withExternalID(String externalID)

Feeds the externalID and returns the builder

Parameters:

externalID - the externalID to feed

Returns:

the builder

Throws:

IllegalArgumentException - - if externalID is null or blank

withLanguageCode

INotificationRecipientBuilder withLanguageCode(String languageCode)

Feeds the languageCode and returns the builder

Parameters:

languageCode - the languageCode to feed

Returns:

the builder

Throws:

IllegalArgumentException - - if languageCode is null or blank

withEmail

INotificationRecipientBuilder withEmail(String email)

Feeds the e-mail and returns the builder

Parameters:

email - the e-mail to feed

Returns:

the builder

Throws:

IllegalArgumentException - - if email is null, blank or invalid

withPhoneNumber

INotificationRecipientBuilder withPhoneNumber(String phoneNumber)

Feeds the phone number and returns the builder

Parameters:

phoneNumber - the phone number to feed

Returns:

the builder

Throws:

IllegalArgumentException - - if phoneNumber is null or blank

withMobilePhoneNumber

INotificationRecipientBuilder withMobilePhoneNumber(String mobilePhoneNumber)

Feeds the mobile phone number and returns the builder

Parameters:

mobilePhoneNumber - the mobile phone number to feed

Returns:

the builder

Throws:

IllegalArgumentException - - if mobilePhoneNumber is null or blank

withIUser

INotificationRecipientBuilder withIUser(IUser iUser)

Feeds every data that can be found in the IUser and returns the builder

Parameters:

iUser - the IUser to use to feed data

Returns:

the builder

Throws:

NullPointerException - - if iUser is null

build

INotificationRecipient build()
                      throws NotificationRecipientException

Produces a notification recipient with the information previously fed using "with..." methods

Returns:

the produced notification recipient

Throws:

NotificationRecipientException - - If builder hasn't enough data to produce a notification recipient (use with methods before)