com.helger.photon.basic.object.accarea

Class AccountingArea

java.lang.Object

com.helger.photon.basic.object.AbstractBaseObject

com.helger.photon.basic.object.client.AbstractClientObject

com.helger.photon.basic.object.accarea.AccountingArea

All Implemented Interfaces:

com.helger.commons.id.IHasID<String>, com.helger.commons.name.IHasDisplayName, com.helger.commons.type.IHasType, com.helger.commons.type.ITypedObject<String>, com.helger.datetime.IHasCreationDateTime, com.helger.datetime.IHasDeletionDateTime, com.helger.datetime.IHasLastModificationDateTime, IHasCreationInfo, IHasDeletionInfo, IHasLastModificationInfo, IAccountingArea, IClientObject, IHasClient, IHasClientID, IObject, IHasUIText

@NotThreadSafe
public final class AccountingArea
extends AbstractClientObject
implements IAccountingArea

Default implementation of IAccountingArea

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
static com.helger.commons.type.ObjectType	OT

Constructor Summary

Constructors

Constructor and Description

AccountingArea(IClient aClient, String sDisplayName, String sCompanyType, String sCompanyVATIN, String sCompanyNumber, com.helger.masterdata.address.IReadonlyAddress aAddress, String sTelephone, String sFax, String sEmailAddress, String sWebSite, com.helger.masterdata.currency.ECurrency eDefaultCurrency, String sOfficeLocation, String sCommercialRegistrationNumber, String sCommercialCourt, Locale aDisplayLocale) Constructor for new accounting area

Method Summary

Methods

Modifier and Type	Method and Description
com.helger.masterdata.address.IReadonlyAddress	getAddress()
String	getAsUIText(Locale aDisplayLocale)
String	getCommercialCourt()
String	getCommercialRegistrationNumber()
String	getCompanyNumber()
String	getCompanyType()
String	getCompanyVATIN()
com.helger.masterdata.currency.ECurrency	getDefaultCurrency()
String	getDefaultCurrencyID()
String	getDisplayName()
String	getEmailAddress()
String	getFax()
String	getOfficeLocation()
String	getTelephone()
com.helger.commons.type.ObjectType	getTypeID()
String	getWebSite()
com.helger.commons.state.EChange	setAddress(com.helger.masterdata.address.IReadonlyAddress aAddress, Locale aDisplayLocale)
com.helger.commons.state.EChange	setCommercialCourt(String sCommercialCourt)
com.helger.commons.state.EChange	setCommercialRegistrationNumber(String sCommercialRegistrationNumber)
com.helger.commons.state.EChange	setCompanyNumber(String sCompanyNumber)
com.helger.commons.state.EChange	setCompanyType(String sCompanyType)
com.helger.commons.state.EChange	setCompanyVATIN(String sCompanyVATIN)
com.helger.commons.state.EChange	setDefaultCurrency(com.helger.masterdata.currency.ECurrency eDefaultCurrency)
com.helger.commons.state.EChange	setDisplayName(String sDisplayName)
com.helger.commons.state.EChange	setEmailAddress(String sEmailAddress)
com.helger.commons.state.EChange	setFax(String sFax)
com.helger.commons.state.EChange	setOfficeLocation(String sOfficeLocation)
com.helger.commons.state.EChange	setTelephone(String sTelephone)
com.helger.commons.state.EChange	setWebSite(String sWebSite)
String	toString()

Methods inherited from class com.helger.photon.basic.object.client.AbstractClientObject

equals, getClient, getClientID, hashCode, hasSameClient, hasSameClientID, hasSameClientID

Methods inherited from class com.helger.photon.basic.object.AbstractBaseObject

getCreationDateTime, getCreationUserID, getDeletionDateTime, getDeletionUserID, getID, getLastModificationDateTime, getLastModificationUserID, isDeleted, isDeleted, isDeleted, setDeletion, setDeletionNow, setLastModification, setLastModificationNow, setUndeletion, setUndeletionNow

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.helger.photon.basic.object.client.IClientObject

getClient, getClientID

Methods inherited from interface com.helger.photon.basic.object.IObject

getCreationDateTime, getCreationUserID, isDeleted, isDeleted, isDeleted

Methods inherited from interface com.helger.commons.id.IHasID

getID

Methods inherited from interface com.helger.photon.basic.datetime.IHasLastModificationInfo

getLastModificationUserID

Methods inherited from interface com.helger.datetime.IHasLastModificationDateTime

getLastModificationDateTime

Methods inherited from interface com.helger.photon.basic.datetime.IHasDeletionInfo

getDeletionUserID

Methods inherited from interface com.helger.datetime.IHasDeletionDateTime

getDeletionDateTime

Methods inherited from interface com.helger.photon.basic.object.client.IHasClient

hasSameClient, hasSameClientID

Methods inherited from interface com.helger.photon.basic.object.client.IHasClientID

hasSameClientID

Field Detail

OT

public static final com.helger.commons.type.ObjectType OT

Constructor Detail

AccountingArea

public AccountingArea(@Nonnull
              IClient aClient,
              @Nonnull@Nonempty
              String sDisplayName,
              @Nullable
              String sCompanyType,
              @Nullable
              String sCompanyVATIN,
              @Nullable
              String sCompanyNumber,
              @Nonnull
              com.helger.masterdata.address.IReadonlyAddress aAddress,
              @Nullable
              String sTelephone,
              @Nullable
              String sFax,
              @Nullable
              String sEmailAddress,
              @Nullable
              String sWebSite,
              @Nullable
              com.helger.masterdata.currency.ECurrency eDefaultCurrency,
              @Nullable
              String sOfficeLocation,
              @Nullable
              String sCommercialRegistrationNumber,
              @Nullable
              String sCommercialCourt,
              @Nonnull
              Locale aDisplayLocale)

Constructor for new accounting area

Parameters:

aClient - Client

sDisplayName - display name

sCompanyType - company type

sCompanyVATIN - company VATIN

sCompanyNumber - company number

aAddress - address

sTelephone - Telephone number

sFax - Fax number

sEmailAddress - Email address

sWebSite - Web site

eDefaultCurrency - default currency

sOfficeLocation - Office location

sCommercialRegistrationNumber - Commercial registration number

sCommercialCourt - Commercial court

aDisplayLocale - The display locale to use. May not be null.

Method Detail

getTypeID

@Nonnull
public com.helger.commons.type.ObjectType getTypeID()

Specified by:

getTypeID in interface com.helger.commons.type.IHasType

getDisplayName

@Nonnull
@Nonempty
public String getDisplayName()

Specified by:

getDisplayName in interface com.helger.commons.name.IHasDisplayName

setDisplayName

@Nonnull
public com.helger.commons.state.EChange setDisplayName(@Nonnull@Nonempty
                                                      String sDisplayName)

getCompanyType

@Nullable
public String getCompanyType()

Specified by:

getCompanyType in interface IAccountingArea

Returns:

The company type. E.g. "KEG"

setCompanyType

@Nonnull
public com.helger.commons.state.EChange setCompanyType(@Nullable
                                                      String sCompanyType)

getCompanyVATIN

@Nullable
public String getCompanyVATIN()

Specified by:

getCompanyVATIN in interface IAccountingArea

Returns:

The company UID.

setCompanyVATIN

@Nonnull
public com.helger.commons.state.EChange setCompanyVATIN(@Nullable
                                                       String sCompanyVATIN)

getCompanyNumber

@Nullable
public String getCompanyNumber()

Specified by:

getCompanyNumber in interface IAccountingArea

Returns:

The company number (Interne Betriebsnummer). May not be null.

setCompanyNumber

@Nonnull
public com.helger.commons.state.EChange setCompanyNumber(@Nullable
                                                        String sCompanyNumber)

getAddress

@Nonnull
public com.helger.masterdata.address.IReadonlyAddress getAddress()

Specified by:

getAddress in interface IAccountingArea

Returns:

The address of the owner.

setAddress

@Nonnull
public com.helger.commons.state.EChange setAddress(@Nonnull
                                                  com.helger.masterdata.address.IReadonlyAddress aAddress,
                                                  @Nonnull
                                                  Locale aDisplayLocale)

getTelephone

@Nullable
public String getTelephone()

Specified by:

getTelephone in interface IAccountingArea

Returns:

The telephone number. May be null.

setTelephone

@Nonnull
public com.helger.commons.state.EChange setTelephone(@Nullable
                                                    String sTelephone)

getFax

@Nullable
public String getFax()

Specified by:

getFax in interface IAccountingArea

Returns:

The telefax number. May be null.

setFax

@Nonnull
public com.helger.commons.state.EChange setFax(@Nullable
                                              String sFax)

getEmailAddress

@Nullable
public String getEmailAddress()

Specified by:

getEmailAddress in interface IAccountingArea

Returns:

The email address. May be null.

setEmailAddress

@Nonnull
public com.helger.commons.state.EChange setEmailAddress(@Nullable
                                                       String sEmailAddress)

getWebSite

@Nullable
public String getWebSite()

Specified by:

getWebSite in interface IAccountingArea

Returns:

The web site. May be null.

setWebSite

@Nonnull
public com.helger.commons.state.EChange setWebSite(@Nullable
                                                  String sWebSite)

getDefaultCurrency

@Nullable
public com.helger.masterdata.currency.ECurrency getDefaultCurrency()

Specified by:

getDefaultCurrency in interface IAccountingArea

Returns:

The default currency in this client. May be null.

getDefaultCurrencyID

@Nullable
public String getDefaultCurrencyID()

Specified by:

getDefaultCurrencyID in interface IAccountingArea

Returns:

The default currency ID in this client. May be null.

setDefaultCurrency

@Nonnull
public com.helger.commons.state.EChange setDefaultCurrency(@Nullable
                                                          com.helger.masterdata.currency.ECurrency eDefaultCurrency)

getOfficeLocation

@Nullable
public String getOfficeLocation()

Specified by:

getOfficeLocation in interface IAccountingArea

Returns:

Office location (Firmensitz)

setOfficeLocation

@Nonnull
public com.helger.commons.state.EChange setOfficeLocation(@Nullable
                                                         String sOfficeLocation)

getCommercialRegistrationNumber

@Nullable
public String getCommercialRegistrationNumber()

Specified by:

getCommercialRegistrationNumber in interface IAccountingArea

Returns:

Commercial registration number (e.g. Firmenbuchnummer)

setCommercialRegistrationNumber

@Nonnull
public com.helger.commons.state.EChange setCommercialRegistrationNumber(@Nullable
                                                                       String sCommercialRegistrationNumber)

getCommercialCourt

@Nullable
public String getCommercialCourt()

Specified by:

getCommercialCourt in interface IAccountingArea

Returns:

Commercial court(e.g. Firmenbuchgericht)

setCommercialCourt

@Nonnull
public com.helger.commons.state.EChange setCommercialCourt(@Nullable
                                                          String sCommercialCourt)

getAsUIText

@Nonnull
@Nonempty
public String getAsUIText(Locale aDisplayLocale)

Specified by:

getAsUIText in interface IHasUIText

Parameters:

aDisplayLocale - Display locale. May not be null.

Returns:

The UI text

toString

public String toString()

Overrides:

toString in class AbstractClientObject