Account (TurnOnline.biz Ecosystem Administration 0.1 API)

java.lang.Object
- biz.turnonline.ecosystem.widget.shared.rest.account.Account

All Implemented Interfaces:: RelevantNullChecker

public class Account
extends Object
implements RelevantNullChecker

Constructor Summary

Constructors
Constructor and Description

Account()

Constructors
Constructor and Description
`Account()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`allNull()` Checks whether this resource has at least a single property with non `null` value within its tree, among those that has been included to be checked.
`Account`	`business(AccountBusiness business)` The business account details.
`Account`	`company(Boolean company)` The boolean indicating whether this account represents a business account.
`Account`	`contactEmail(String contactEmail)` The email address considered as a contact email used for notification purposes related to this account (supports comma separated list).
`Account`	`email(String email)` The login email address as the account unique identification, taken from the login provider as an authenticated email.
`Account`	`firstName(String firstName)` The personal / sub account, person first name.
`AccountBusiness`	`getBusiness()`
`Boolean`	`getCompany()`
`String`	`getContactEmail()`
`String`	`getEmail()`
`String`	`getFirstName()`
`Boolean`	`getHasPostalAddress()`
`Long`	`getId()`
`String`	`getIdentityId()`
`InvoicingConfig`	`getInvoicing()`
`String`	`getLastName()`
`String`	`getLocale()`
`String`	`getMiddleName()`
`Date`	`getModificationDate()`
`AccountPersonalAddress`	`getPersonalAddress()`
`AccountPostalAddress`	`getPostalAddress()`
`String`	`getPrefix()`
`AccountPublicContact`	`getPublicContact()`
`String`	`getRole()`
`String`	`getSuffix()`
`String`	`getZoneId()`
`Account`	`hasPostalAddress(Boolean hasPostalAddress)` If true, the postal address is not same as the company address and must be provided.
`Account`	`id(Long id)` The account unique identification
`Account`	`identityId(String identityId)` The email account unique identification within third-party provider system.
`Account`	`invoicing(InvoicingConfig invoicing)` The set of default invoicing rules.
`Account`	`lastName(String lastName)` The personal / sub account, person last name.
`Account`	`locale(String locale)` The preferred account language.
`Account`	`middleName(String middleName)` The personal / sub account, person middle name.
`Account`	`modificationDate(Date modificationDate)` The date and time of the last modification of entity values.
`Account`	`personalAddress(AccountPersonalAddress personalAddress)` The personal account address details.
`Account`	`postalAddress(AccountPostalAddress postalAddress)` The postal address details.
`Account`	`prefix(String prefix)` The personal / sub account, person name prefix.
`Account`	`publicContact(AccountPublicContact publicContact)` The public contact of the account, might be publicly available.
`Account`	`role(String role)` The account role
`void`	`setBusiness(AccountBusiness business)`
`boolean`	`setBusinessIf(AccountBusiness business)`
`void`	`setCompany(Boolean company)`
`void`	`setContactEmail(String contactEmail)`
`void`	`setEmail(String email)`
`void`	`setFirstName(String firstName)`
`void`	`setHasPostalAddress(Boolean hasPostalAddress)`
`void`	`setId(Long id)`
`void`	`setIdentityId(String identityId)`
`void`	`setInvoicing(InvoicingConfig invoicing)`
`boolean`	`setInvoicingIf(InvoicingConfig invoicing)`
`void`	`setLastName(String lastName)`
`void`	`setLocale(String locale)`
`void`	`setMiddleName(String middleName)`
`void`	`setModificationDate(Date modificationDate)`
`void`	`setPersonalAddress(AccountPersonalAddress personalAddress)`
`boolean`	`setPersonalAddressIf(AccountPersonalAddress personalAddress)`
`void`	`setPostalAddress(AccountPostalAddress postalAddress)`
`boolean`	`setPostalAddressIf(AccountPostalAddress postalAddress)`
`void`	`setPrefix(String prefix)`
`void`	`setPublicContact(AccountPublicContact publicContact)`
`boolean`	`setPublicContactIf(AccountPublicContact publicContact)`
`void`	`setRole(String role)`
`void`	`setSuffix(String suffix)`
`void`	`setZoneId(String zoneId)`
`Account`	`suffix(String suffix)` The personal / sub account, person name suffix.
`Account`	`zoneId(String zoneId)` A time-zone ID, such as Europe/Paris.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface biz.turnonline.ecosystem.widget.shared.rest.RelevantNullChecker
allNull, setIfNotAllNull

Constructor Detail
- Account
```
public Account()
```

Method Detail

id
```
public Account id(Long id)
```
The account unique identification

getId
```
public Long getId()
```

setId
```
public void setId(Long id)
```

email
```
public Account email(String email)
```
The login email address as the account unique identification, taken from the login provider as an authenticated email.

getEmail
```
public String getEmail()
```

setEmail
```
public void setEmail(String email)
```

identityId
```
public Account identityId(String identityId)
```
The email account unique identification within third-party provider system. Taken from the login provider.

getIdentityId
```
public String getIdentityId()
```

setIdentityId

public void setIdentityId(String identityId)

contactEmail
```
public Account contactEmail(String contactEmail)
```
The email address considered as a contact email used for notification purposes related to this account (supports comma separated list). If it's not provided the account's email will be used by default.

getContactEmail
```
public String getContactEmail()
```

setContactEmail

public void setContactEmail(String contactEmail)

role
```
public Account role(String role)
```
The account role

getRole
```
public String getRole()
```

setRole
```
public void setRole(String role)
```

locale
```
public Account locale(String locale)
```
The preferred account language. ISO 639 alpha-2 or alpha-3 language code.

getLocale
```
public String getLocale()
```

setLocale
```
public void setLocale(String locale)
```

prefix
```
public Account prefix(String prefix)
```
The personal / sub account, person name prefix.

getPrefix
```
public String getPrefix()
```

setPrefix
```
public void setPrefix(String prefix)
```

firstName
```
public Account firstName(String firstName)
```
The personal / sub account, person first name.

getFirstName
```
public String getFirstName()
```

setFirstName

public void setFirstName(String firstName)

middleName
```
public Account middleName(String middleName)
```
The personal / sub account, person middle name.

getMiddleName
```
public String getMiddleName()
```

setMiddleName

public void setMiddleName(String middleName)

lastName
```
public Account lastName(String lastName)
```
The personal / sub account, person last name.

getLastName
```
public String getLastName()
```

setLastName

public void setLastName(String lastName)

suffix
```
public Account suffix(String suffix)
```
The personal / sub account, person name suffix.

getSuffix
```
public String getSuffix()
```

setSuffix
```
public void setSuffix(String suffix)
```

modificationDate
```
public Account modificationDate(Date modificationDate)
```
The date and time of the last modification of entity values. Populated by the service.

getModificationDate
```
public Date getModificationDate()
```

setModificationDate

public void setModificationDate(Date modificationDate)

zoneId
```
public Account zoneId(String zoneId)
```
A time-zone ID, such as Europe/Paris. Used to identify the rules how to render date time properties of the resources associated with this account. It's a case sensitive. The default set of data is supplied by the IANA Time Zone Database (TZDB). This has region IDs of the form '{area}/{city}', such as 'Europe/Paris' or 'America/New_York'. If zone ID has an invalid format or cannot be found a bad request will be thrown.

getZoneId
```
public String getZoneId()
```

setZoneId
```
public void setZoneId(String zoneId)
```

personalAddress

public Account personalAddress(AccountPersonalAddress personalAddress)

The personal account address details.

getPersonalAddress

public AccountPersonalAddress getPersonalAddress()

setPersonalAddress

public void setPersonalAddress(AccountPersonalAddress personalAddress)

publicContact
```
public Account publicContact(AccountPublicContact publicContact)
```
The public contact of the account, might be publicly available.

getPublicContact

public AccountPublicContact getPublicContact()

setPublicContact

public void setPublicContact(AccountPublicContact publicContact)

hasPostalAddress
```
public Account hasPostalAddress(Boolean hasPostalAddress)
```
If true, the postal address is not same as the company address and must be provided.

getHasPostalAddress
```
public Boolean getHasPostalAddress()
```

setHasPostalAddress

public void setHasPostalAddress(Boolean hasPostalAddress)

postalAddress
```
public Account postalAddress(AccountPostalAddress postalAddress)
```
The postal address details. The address is being ignored until property \"hasPostalAddress\" is set to true.

getPostalAddress

public AccountPostalAddress getPostalAddress()

setPostalAddress

public void setPostalAddress(AccountPostalAddress postalAddress)

company
```
public Account company(Boolean company)
```
The boolean indicating whether this account represents a business account. The missing value or false means it's a personal account.

getCompany
```
public Boolean getCompany()
```

setCompany

public void setCompany(Boolean company)

business
```
public Account business(AccountBusiness business)
```
The business account details. If the property \"company\" is false, the posted values will be stored anyway for further use, however account is still being considered as a personal account.

getBusiness
```
public AccountBusiness getBusiness()
```

setBusiness

public void setBusiness(AccountBusiness business)

invoicing
```
public Account invoicing(InvoicingConfig invoicing)
```
The set of default invoicing rules. Valid only for an account representing a business account (configured by \"company\" property).

getInvoicing
```
public InvoicingConfig getInvoicing()
```

setInvoicing

public void setInvoicing(InvoicingConfig invoicing)

setPersonalAddressIf

public boolean setPersonalAddressIf(AccountPersonalAddress personalAddress)

setPublicContactIf

public boolean setPublicContactIf(AccountPublicContact publicContact)

setPostalAddressIf

public boolean setPostalAddressIf(AccountPostalAddress postalAddress)

setBusinessIf

public boolean setBusinessIf(AccountBusiness business)

setInvoicingIf

public boolean setInvoicingIf(InvoicingConfig invoicing)

allNull
```
public boolean allNull()
```
Description copied from interface: RelevantNullChecker

Checks whether this resource has at least a single property with non null value within its tree, among those that has been included to be checked.

Specified by:

allNull in interface RelevantNullChecker

Returns:

true if at least a single property of this resource has a non null value, otherwise false

Class Account

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface biz.turnonline.ecosystem.widget.shared.rest.RelevantNullChecker

Constructor Detail

Account

Method Detail

id

getId

setId

email

getEmail

setEmail

identityId

getIdentityId

setIdentityId

contactEmail

getContactEmail

setContactEmail

role

getRole

setRole

locale

getLocale

setLocale

prefix

getPrefix

setPrefix

firstName

getFirstName

setFirstName

middleName

getMiddleName

setMiddleName

lastName

getLastName

setLastName

suffix

getSuffix

setSuffix

modificationDate

getModificationDate

setModificationDate

zoneId

getZoneId

setZoneId

personalAddress

getPersonalAddress

setPersonalAddress

publicContact

getPublicContact

setPublicContact

hasPostalAddress

getHasPostalAddress

setHasPostalAddress

postalAddress

getPostalAddress

setPostalAddress

company

getCompany

setCompany

business

getBusiness

setBusiness

invoicing

getInvoicing

setInvoicing

setPersonalAddressIf

setPublicContactIf

setPostalAddressIf

setBusinessIf

setInvoicingIf

allNull