com.helger.photon.basic.object.accarea

Class AccountingAreaManager

java.lang.Object

com.helger.photon.basic.app.dao.impl.AbstractDAO

com.helger.photon.basic.app.dao.impl.AbstractSimpleDAO

com.helger.photon.basic.object.accarea.AccountingAreaManager

All Implemented Interfaces:

IAutoSaveAware, IChangeable, IDAO, IAccountingAreaResolver

public final class AccountingAreaManager
extends AbstractSimpleDAO
implements IAccountingAreaResolver

Manages all available accounting areas.

Author:

Philip Helger

Nested Class Summary

Nested classes/interfaces inherited from interface com.helger.photon.basic.app.dao.IDAO

IDAO.EMode

Field Summary

Fields inherited from class com.helger.photon.basic.app.dao.impl.AbstractDAO

DEFAULT_AUTO_SAVE_ENABLED, m_aRWLock

Constructor Summary

Constructors

Constructor and Description
AccountingAreaManager(String sFilename)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	containsAccountingAreaWithID(String sID)
boolean	containsAccountingAreaWithID(String sID, IClient aClient)
IAccountingArea	createAccountingArea(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)
protected com.helger.commons.microdom.IMicroDocument	createWriteData() Create the XML document that should be saved to the file.
IAccountingArea	getAccountingAreaOfID(String sID) Get the accounting area of the specified ID.
IAccountingArea	getAccountingAreaOfID(String sID, IClient aClient)
IAccountingArea	getAccountingAreaOfName(String sName, IClient aClient)
Collection<String>	getAllAccountingAreaIDsOfClient(IClient aClient)
Collection<String>	getAllAccountingAreaIDsOfClient(String sClientID)
Collection<? extends IAccountingArea>	getAllAccountingAreas()
Collection<? extends IAccountingArea>	getAllAccountingAreasOfClient(IClient aClient)
Collection<? extends IAccountingArea>	getAllAccountingAreasOfClient(String sClientID)
protected com.helger.commons.state.EChange	onRead(com.helger.commons.microdom.IMicroDocument aDoc) Fill the internal structures with from the passed XML document.
com.helger.commons.state.EChange	updateAccountingArea(String sAccountingAreaID, 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)

Methods inherited from class com.helger.photon.basic.app.dao.impl.AbstractSimpleDAO

beforeWriteToFile, getDAOIO, getFilenameProvider, getInitCount, getLastFilename, getLastInitDateTime, getLastReadDateTime, getLastWriteDateTime, getReadCount, getSafeFile, getWriteCount, getXMLWriterSettings, initialRead, markAsChanged, modifyWriteData, onFilenameChange, onInit, toString, triggerExceptionHandlersRead, triggerExceptionHandlersWrite, writeToFileOnPendingChanges

Methods inherited from class com.helger.photon.basic.app.dao.impl.AbstractDAO

beginWithoutAutoSave, endWithoutAutoSave, getExceptionHandlersRead, getExceptionHandlersWrite, hasPendingChanges, internalHasPendingChanges, internalIsAutoSaveEnabled, internalSetPendingChanges, isAutoSaveEnabled, performWithoutAutoSave, performWithoutAutoSave, performWithoutAutoSave, performWithoutAutoSave

Methods inherited from class java.lang.Object

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

Constructor Detail

AccountingAreaManager

public AccountingAreaManager(@Nonnull@Nonempty
                     String sFilename)
                      throws DAOException

Throws:

DAOException

Method Detail

onRead

@Nonnull
protected com.helger.commons.state.EChange onRead(@Nonnull
                                              com.helger.commons.microdom.IMicroDocument aDoc)

Description copied from class: AbstractSimpleDAO

Fill the internal structures with from the passed XML document. This method is only called within a write lock!

Specified by:

onRead in class AbstractSimpleDAO

Parameters:

aDoc - The XML document to read from. Never null.

Returns:

EChange.CHANGED if reading the data changed something in the internal structures that requires a writing.

createWriteData

@Nonnull
protected com.helger.commons.microdom.IMicroDocument createWriteData()

Description copied from class: AbstractSimpleDAO

Create the XML document that should be saved to the file. This method is only called within a write lock!

Specified by:

createWriteData in class AbstractSimpleDAO

Returns:

The non-null document to write to the file.

createAccountingArea

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

updateAccountingArea

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

getAllAccountingAreas

@Nonnull
@ReturnsMutableCopy
public Collection<? extends IAccountingArea> getAllAccountingAreas()

getAllAccountingAreasOfClient

@Nonnull
@ReturnsMutableCopy
public Collection<? extends IAccountingArea> getAllAccountingAreasOfClient(@Nullable
                                                                                             String sClientID)

getAllAccountingAreasOfClient

@Nonnull
@ReturnsMutableCopy
public Collection<? extends IAccountingArea> getAllAccountingAreasOfClient(@Nullable
                                                                                             IClient aClient)

getAllAccountingAreaIDsOfClient

@Nonnull
@ReturnsMutableCopy
public Collection<String> getAllAccountingAreaIDsOfClient(@Nullable
                                                                            String sClientID)

getAllAccountingAreaIDsOfClient

@Nonnull
@ReturnsMutableCopy
public Collection<String> getAllAccountingAreaIDsOfClient(@Nullable
                                                                            IClient aClient)

getAccountingAreaOfID

@Nullable
public IAccountingArea getAccountingAreaOfID(@Nullable
                                             String sID)

Description copied from interface: IAccountingAreaResolver

Get the accounting area of the specified ID.

Specified by:

getAccountingAreaOfID in interface IAccountingAreaResolver

Parameters:

sID - The ID to be resolved. May be null.

Returns:

null if no such accounting area exists.

getAccountingAreaOfID

public IAccountingArea getAccountingAreaOfID(@Nullable
                                    String sID,
                                    @Nullable
                                    IClient aClient)

containsAccountingAreaWithID

public boolean containsAccountingAreaWithID(@Nullable
                                   String sID)

containsAccountingAreaWithID

public boolean containsAccountingAreaWithID(@Nullable
                                   String sID,
                                   @Nullable
                                   IClient aClient)

getAccountingAreaOfName

@Nullable
public IAccountingArea getAccountingAreaOfName(@Nullable
                                               String sName,
                                               @Nullable
                                               IClient aClient)