com.blockscore.models

Class Company.Builder

java.lang.Object

com.blockscore.models.Company.Builder

Enclosing class:

Company

public static class Company.Builder
extends java.lang.Object

The builder used for constructing a Company.

Constructor Summary

Constructors

Constructor and Description
Builder(BlockscoreApiClient client)

Method Summary

Modifier and Type	Method and Description
Company	create() Creates a new Company.
Company.Builder	setAddress(Address address) Sets the company's address.
Company.Builder	setDbas(java.lang.String dbas) Sets the "doing business as" names for the company.
Company.Builder	setEmail(java.lang.String email) Sets the email for this entity.
Company.Builder	setEntityName(java.lang.String entityName) Name of entity.
Company.Builder	setIncorporationCountryCode(java.lang.String incorporationCountryCode) Sets the incorporation country code.
Company.Builder	setIncorporationDate(java.util.Date incorporationDate) Sets the incorporation date.
Company.Builder	setIncorporationState(java.lang.String incorporationState) Sets the incorporation state.
Company.Builder	setIncorporationType(CorporationType incorporationType) Sets the incorporation type.
Company.Builder	setIpAddress(java.lang.String ipAddress) Sets a company's IP address.
Company.Builder	setNote(java.lang.String note) Store additional information about the candidate here such as your internal system's identifier for this individual.
Company.Builder	setPhoneNumber(java.lang.String phoneNumber) Sets a company's phone number.
Company.Builder	setRegistrationNumber(java.lang.String registrationNumber) Sets the registration number for this entity.
Company.Builder	setTaxId(java.lang.String taxId) Sets the Tax ID for this entity.
Company.Builder	setUrl(java.lang.String url) Sets the URL for this business.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(BlockscoreApiClient client)

Method Detail

setEntityName

@NotNull
public Company.Builder setEntityName(@NotNull
                                              java.lang.String entityName)

Name of entity. This should exclude any legal endings like "Co" or "Inc" for best results.

Parameters:

entityName - Name

Returns:

this

setTaxId

@NotNull
public Company.Builder setTaxId(@NotNull
                                         java.lang.String taxId)

Sets the Tax ID for this entity. The tax ID should only include the digits of the ID with no extraneous characters like dashes.

Parameters:

taxId - the tax ID for the company

Returns:

this

setIncorporationState

@NotNull
public Company.Builder setIncorporationState(@Nullable
                                                      java.lang.String incorporationState)

Sets the incorporation state. Can be either of ISO code form or the full length name of the state.

Parameters:

incorporationState - the incorporation state

Returns:

this

setIncorporationCountryCode

@NotNull
public Company.Builder setIncorporationCountryCode(@NotNull
                                                            java.lang.String incorporationCountryCode)

Sets the incorporation country code. Should be of the ISO alpha-2 code form.

Parameters:

incorporationCountryCode - the country code

Returns:

this

setIncorporationType

public Company.Builder setIncorporationType(@NotNull
                                            CorporationType incorporationType)

Sets the incorporation type.

Parameters:

incorporationType - the corporation type

Returns:

this

setIncorporationDate

@NotNull
public Company.Builder setIncorporationDate(@Nullable
                                                     java.util.Date incorporationDate)

Sets the incorporation date.

Parameters:

incorporationDate - the incorporation date

Returns:

this

setDbas

public Company.Builder setDbas(@Nullable
                               java.lang.String dbas)

Sets the "doing business as" names for the company.

Parameters:

dbas - the doing business as names

Returns:

this.

setRegistrationNumber

public Company.Builder setRegistrationNumber(@Nullable
                                             java.lang.String registrationNumber)

Sets the registration number for this entity. Should only include the digits of the registration number with no extraneous characters like dashes.

Parameters:

registrationNumber - the registration number

Returns:

this

setEmail

public Company.Builder setEmail(@Nullable
                                java.lang.String email)

Sets the email for this entity. Any form of valid email is accepted.

Parameters:

email - the email address

Returns:

this

setUrl

public Company.Builder setUrl(@Nullable
                              java.lang.String url)

Sets the URL for this business. Can either contain protocol information or not (ex. www.example.com and http://www.example.com).

Parameters:

url - the URL

Returns:

this

setPhoneNumber

@NotNull
public Company.Builder setPhoneNumber(@Nullable
                                               java.lang.String phoneNumber)

Sets a company's phone number. Extra characters like parenthesis and dashes are accepted - can either contain the country code or not.

Parameters:

phoneNumber - the phone number

Returns:

this

setIpAddress

@NotNull
public Company.Builder setIpAddress(@Nullable
                                             java.lang.String ipAddress)

Sets a company's IP address. Both IPv4 and IPv6 style IP addresses are acceptable.

Parameters:

ipAddress - the IP address

Returns:

this

setNote

@NotNull
public Company.Builder setNote(@Nullable
                                        java.lang.String note)

Store additional information about the candidate here such as your internal system's identifier for this individual. This will allow you to keep track of them.

Parameters:

note - the additional information

Returns:

this

setAddress

public Company.Builder setAddress(@NotNull
                                  Address address)

Sets the company's address.

Parameters:

address - the address

Returns:

this

create

public Company create()

Creates a new Company.

Returns:

the new company