com.microstrategy.ushersdk

Class OwnerEntity.Builder

java.lang.Object

com.microstrategy.ushersdk.OwnerEntity.Builder

Enclosing class:

OwnerEntity

public abstract static class OwnerEntity.Builder
extends java.lang.Object

The OwnerEntity.Builder abstract class allows the user to create and return a OwnerEntity object. For example,
return DriverEntity.builder()
.email("johndoe@johndoe.com")
.name("John Doe")
.partner2Id(null)
.phone("1234567890")
.userRole(UserRole.PRIMARY_DRIVER)
.uid("12345")
.build();

Method Summary

Modifier and Type	Method and Description
abstract OwnerEntity	build() Builds the OwnerEntity object that is used to wrap various properties related to a driver.
abstract OwnerEntity.Builder	email(java.lang.String email) Returns the OwnerEntity.Builder for the OwnerEntity.email() component of the OwnerEntity object.
abstract OwnerEntity.Builder	name(java.lang.String name) Returns the OwnerEntity.Builder for the OwnerEntity.name() component of the OwnerEntity object.
abstract OwnerEntity.Builder	partner2Id(java.lang.String partner2Id) Returns the OwnerEntity.Builder for the OwnerEntity.partner2Id() component of the OwnerEntity object.
abstract OwnerEntity.Builder	phone(java.lang.String phone) Returns the OwnerEntity.Builder for the OwnerEntity.phone() component of the OwnerEntity object.
abstract OwnerEntity.Builder	role(java.lang.String role) Returns the OwnerEntity.Builder for the OwnerEntity.role() component of the OwnerEntity object.
abstract OwnerEntity.Builder	uid(java.lang.String uid) Returns the OwnerEntity.Builder for the OwnerEntity.uid() component of the OwnerEntity object.

Methods inherited from class java.lang.Object

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

Method Detail

email

public abstract OwnerEntity.Builder email(java.lang.String email)

Returns the OwnerEntity.Builder for the OwnerEntity.email() component of the OwnerEntity object.

Parameters:

email - the email address of the driver

Returns:

the OwnerEntity.Builder for the OwnerEntity.email() component of the OwnerEntity object.

name

public abstract OwnerEntity.Builder name(java.lang.String name)

Returns the OwnerEntity.Builder for the OwnerEntity.name() component of the OwnerEntity object.

Parameters:

name - the name of the driver

Returns:

the OwnerEntity.Builder for the OwnerEntity.name() component of the OwnerEntity object.

partner2Id

public abstract OwnerEntity.Builder partner2Id(@Nullable
                                               java.lang.String partner2Id)

Returns the OwnerEntity.Builder for the OwnerEntity.partner2Id() component of the OwnerEntity object.

Parameters:

partner2Id - the identification number of the secondary driver. May be null

Returns:

the OwnerEntity.Builder for the OwnerEntity.partner2Id() component of the OwnerEntity object.

phone

public abstract OwnerEntity.Builder phone(java.lang.String phone)

Returns the OwnerEntity.Builder for the OwnerEntity.phone() component of the OwnerEntity object.

Parameters:

phone - the mobile phone number of the driver, including country code

Returns:

the OwnerEntity.Builder for the OwnerEntity.phone() component of the OwnerEntity object.

role

public abstract OwnerEntity.Builder role(java.lang.String role)

Returns the OwnerEntity.Builder for the OwnerEntity.role() component of the OwnerEntity object.

Parameters:

role - the user role of the driver

Returns:

the OwnerEntity.Builder for the OwnerEntity.role() component of the OwnerEntity object.

uid

public abstract OwnerEntity.Builder uid(@Nullable
                                        java.lang.String uid)

Returns the OwnerEntity.Builder for the OwnerEntity.uid() component of the OwnerEntity object.

Parameters:

uid - the Usher ID of the driver. May be null

Returns:

the OwnerEntity.Builder for the OwnerEntity.uid() component of the OwnerEntity object.

build

public abstract OwnerEntity build()

Builds the OwnerEntity object that is used to wrap various properties related to a driver.

Returns:

the OwnerEntity object that is used to wrap various properties related to a driver.