org.assistments.service.manager.builders

Class UserBuilder

java.lang.Object

org.assistments.service.manager.validation.ValidationRegistryImpl

org.assistments.service.manager.builders.UserBuilder

All Implemented Interfaces:

DomainObjectBuilder<User>, ValidationRegistry

public class UserBuilder
extends ValidationRegistryImpl
implements DomainObjectBuilder<User>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UserBuilder.LoginNameSyntaxType

Constructor Summary

Constructors

Constructor and Description
UserBuilder(User userDTO) This is a convenience constructor for applications using the User object as a Data Transfer Object (DTO) between client (browser) and server (here).
UserBuilder(UserType userType) For validation purposes, creates a UserBuilder from a User object.

Method Summary

Modifier and Type	Method and Description
User	getDomainObject() Returns the validated, built domain object.
UserBuilder	setActive(boolean isActive) Specifies whether the new User is enabled.
UserBuilder	setBirthdate(java.time.Instant birthdate)
UserBuilder	setDisplayName(java.lang.String displayName)
UserBuilder	setFirstName(java.lang.String firstName)
UserBuilder	setLastName(java.lang.String lastName)
UserBuilder	setLogin(java.lang.String loginName, UserBuilder.LoginNameSyntaxType isEmailAddr)
UserBuilder	setNames(java.lang.String firstName, java.lang.String lastName, java.lang.String displayName)
UserBuilder	setPassword(java.lang.String password)
UserBuilder	setPasswordValidator(Validator<java.lang.String> pwv)
UserBuilder	setTimeZone(java.lang.String timeZone)

Methods inherited from class org.assistments.service.manager.validation.ValidationRegistryImpl

addFailures, addFailures, addToValidationQueue, addToValidationQueue, addToValidationQueue, addToValidationQueue, doValidation, failuresToString, getFailures, hasFailures, overrideValidator, setValidator, throwBuilderExceptionOnFailure, throwIllegalArgumentExceptionOnFailure

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.assistments.service.manager.validation.ValidationRegistry

addFailures, addFailures, addToValidationQueue, addToValidationQueue, addToValidationQueue, addToValidationQueue, doValidation, failuresToString, getFailures, getInstance, hasFailures, overrideValidator, setValidator, throwBuilderExceptionOnFailure, throwIllegalArgumentExceptionOnFailure

Constructor Detail

UserBuilder

public UserBuilder(UserType userType)

For validation purposes, creates a UserBuilder from a User object.

It is convenient to use User as a DTO from client to server, but doing so misses, or places validation rules on the client-side code, or the application's server-side code.

Instead of that, we force validation of a User by having the persist method accept only a UserBuilder. An application can still control validation requirements, but does so by configuring its own UserBuiler in advance of persisting a new User.

Parameters:

user - User instance to validate.

UserBuilder

public UserBuilder(User userDTO)

This is a convenience constructor for applications using the User object as a Data Transfer Object (DTO) between client (browser) and server (here). That is to say, for ex: User input is collected on a form, put into a User instance, serialized, and transmitted to the server which calls this methods.

Parameters:

user -

Method Detail

setBirthdate

public UserBuilder setBirthdate(java.time.Instant birthdate)

setLogin

public UserBuilder setLogin(java.lang.String loginName,
                            UserBuilder.LoginNameSyntaxType isEmailAddr)

setNames

public UserBuilder setNames(java.lang.String firstName,
                            java.lang.String lastName,
                            java.lang.String displayName)

setActive

public UserBuilder setActive(boolean isActive)

Specifies whether the new User is enabled.

By default a User is enabled. Thus you only need to call this method if you wish your new User to begin life in a disabled state.

Parameters:

isActive - true to enable the new User; false to disable the new User.

Returns:

This UserBuidler

setFirstName

public UserBuilder setFirstName(java.lang.String firstName)

setLastName

public UserBuilder setLastName(java.lang.String lastName)

setDisplayName

public UserBuilder setDisplayName(java.lang.String displayName)

setTimeZone

public UserBuilder setTimeZone(java.lang.String timeZone)

setPasswordValidator

public UserBuilder setPasswordValidator(Validator<java.lang.String> pwv)

setPassword

public UserBuilder setPassword(java.lang.String password)

getDomainObject

public User getDomainObject()

Description copied from interface: DomainObjectBuilder

Returns the validated, built domain object.

Specified by:

getDomainObject in interface DomainObjectBuilder<User>

Returns:

The newly built domain object.

See Also:

Validator}