org.opencrx.kernel.backend

Class Accounts

java.lang.Object

org.opencrx.kernel.backend.AbstractImpl

org.opencrx.kernel.backend.Accounts

public class Accounts
extends AbstractImpl

Accounts backend class.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Accounts.AddressFilter Callback interface for filtering addresses.

Field Summary

Fields

Modifier and Type	Field and Description
static int	FAX_BUSINESS
static int	FAX_HOME
static int	MAIL_BUSINESS
static int	MAIL_HOME
static int	MAIL_OTHER
static short	MEMBER_QUALITY_NORMAL
static short	MEMBER_ROLE_ASSISTANT
static short	MEMBER_ROLE_EMPLOYEE
static int	MOBILE
static int	PHONE_BUSINESS
static int	PHONE_HOME
static int	PHONE_OTHER
static int	POSTAL_BUSINESS
static int	POSTAL_HOME
static int	WEB_BUSINESS
static int	WEB_HOME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Accounts() Constructor.

Method Summary

Modifier and Type	Method and Description
CheckForAutoUpdateResult	checkForAutoUpdate(AccountAddress address) Check whether address qualifies for auto-update.
int	countFilteredAccount(AbstractFilterAccount accountFilter) Count accounts matching the account filter.
int	countFilteredAddress(AbstractFilterAddress addressFilter) Count addresses matching the given filter.
Invoice	createInvoice(Account account, String name, String description, Invoice basedOn) Deprecated. use contract creators instead
Lead	createLead(Account account, String name, String description, String nextStep, Lead basedOn) Deprecated. use contract creators instead
Opportunity	createOpportunity(Account account, String name, String description, String nextStep, Opportunity basedOn) Deprecated. use contract creators instead
Quote	createQuote(Account account, String name, String description, Quote basedOn) Deprecated. use contract creators instead
SalesOrder	createSalesOrder(Account account, String name, String description, SalesOrder basedOn) Deprecated. use contract creators instead
AccountAddress[]	getAccountAddresses(Account account, Accounts.AddressFilter addressFilter, boolean strict) Return home and business addresses of given account matching the specified address filter.
List<AccountAddress>	getAccountAddresses(Account account, short usage) Get addresses of given account.
Segment	getAccountSegment(javax.jdo.PersistenceManager pm, String providerName, String segmentName) Get account segment.
static Accounts	getInstance() Get Accounts backend instance.
AccountAddress[]	getMainAddresses(Account account) Same as getMainAddresses(account, false)
AccountAddress[]	getMainAddresses(Account account, boolean strict) Return main home and business addresses of given account.
List<Account>	getMatchingAccounts(Segment accountSegment, AccountQuery accountQuery, String fullName, String firstName, String lastName, String aliasName, String phoneNumberMobile, String phoneNumberHome, String phoneNumberBusiness, String postalCityHome, String postalCityBusiness, List<String> postalStreetHome, List<String> postalStreetBusiness, String emailHome, String emailBusiness) Get matching contacts.
String	getPrimaryBusinessEMail(Account account, String hint) Get primary business email address.
String	getPrimaryBusinessPhone(Account account) Get primary business phone of given account.
Account	getUnassignableAddressesHolder(Segment accountSegment) Get holder for new addresses which can not be automatically be assigned to an account.
void	initContract(SalesContract contract, Account account, String name, String description) Deprecated. use contract creators instead.
List<EMailAddress>	lookupEmailAddress(javax.jdo.PersistenceManager pm, String providerName, String segmentName, String emailAddress) Find email addresses matching the given pattern.
List<EMailAddress>	lookupEmailAddress(javax.jdo.PersistenceManager pm, String providerName, String segmentName, String emailAddress, boolean exactCaseInsensitiveOnly) Find email addresses matching the given pattern.
List<EMailAddress>	lookupEmailAddress(javax.jdo.PersistenceManager pm, String providerName, String segmentName, String email, boolean exactCaseInsensitiveOnly, boolean forceCreate) Find email addresses matching the given pattern.
void	markAccountAsDirty(Account account) Touch account.
int	moveAddress(AccountAddress source, AccountAddress target, Date updateRelationshipsSince, Date updateRelationshipsBefore) Replace all references to the source address with the target address.
int	moveAddressToAccount(AccountAddress source, Account targetAccount, Date updateRelationshipsSince, Date updateRelationshipsBefore) Move address to target account.
void	preDelete(org.openmdx.base.accessor.jmi.cci.RefObject_1_0 object, boolean preDelete) Pre-delete callback.
void	preStore(org.openmdx.base.accessor.jmi.cci.RefObject_1_0 object) Pre-store callback.
static void	register() Register Accounts backend instance.
protected void	removeAccount(Account account, boolean preDelete) Callback for removing an account.
protected void	removeAddress(AccountAddress address, boolean preDelete) Callback when address is removed, e.g.
protected void	updateAccount(Account account) Update derived attributes of given account.
void	updateAccountFullName(Account account) Update derived attribute full name of given account.
protected void	updateAddress(AccountAddress address) Update derived attributes of given address.
void	updateAssignedAddresses(AccountAddress address) Update the addresses assigned to the given address.
protected void	updateMember(Member member) Update member callback.
void	updatePostalAddressLine(Account account) Update postal address lines which are derived from account information.
void	updateVcard(Account account) Update VCARD of given account.

Methods inherited from class org.opencrx.kernel.backend.AbstractImpl

getInstance, getUidAsString, registerImpl

Methods inherited from class java.lang.Object

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

Field Detail

MAIL_BUSINESS

public static final int MAIL_BUSINESS

See Also:

Constant Field Values

MAIL_HOME

public static final int MAIL_HOME

See Also:

Constant Field Values

PHONE_BUSINESS

public static final int PHONE_BUSINESS

See Also:

Constant Field Values

PHONE_HOME

public static final int PHONE_HOME

See Also:

Constant Field Values

FAX_BUSINESS

public static final int FAX_BUSINESS

See Also:

Constant Field Values

FAX_HOME

public static final int FAX_HOME

See Also:

Constant Field Values

POSTAL_BUSINESS

public static final int POSTAL_BUSINESS

See Also:

Constant Field Values

WEB_BUSINESS

public static final int WEB_BUSINESS

See Also:

Constant Field Values

POSTAL_HOME

public static final int POSTAL_HOME

See Also:

Constant Field Values

WEB_HOME

public static final int WEB_HOME

See Also:

Constant Field Values

MOBILE

public static final int MOBILE

See Also:

Constant Field Values

PHONE_OTHER

public static final int PHONE_OTHER

See Also:

Constant Field Values

MAIL_OTHER

public static final int MAIL_OTHER

See Also:

Constant Field Values

MEMBER_ROLE_EMPLOYEE

public static final short MEMBER_ROLE_EMPLOYEE

See Also:

Constant Field Values

MEMBER_ROLE_ASSISTANT

public static final short MEMBER_ROLE_ASSISTANT

See Also:

Constant Field Values

MEMBER_QUALITY_NORMAL

public static final short MEMBER_QUALITY_NORMAL

See Also:

Constant Field Values

Constructor Detail

Accounts

protected Accounts()

Constructor.

Method Detail

register

public static void register()

Register Accounts backend instance.

getInstance

public static Accounts getInstance()
                            throws org.openmdx.base.exception.ServiceException

Get Accounts backend instance.

Returns:

Throws:

org.openmdx.base.exception.ServiceException

markAccountAsDirty

public void markAccountAsDirty(Account account)
                        throws org.openmdx.base.exception.ServiceException

Touch account. This way jdoPreStore() will be invoked.

Parameters:

account -

Throws:

org.openmdx.base.exception.ServiceException

initContract

public void initContract(SalesContract contract,
                         Account account,
                         String name,
                         String description)
                  throws org.openmdx.base.exception.ServiceException

Deprecated. use contract creators instead.

Init contract with given values.

Parameters:

contract -

account -

name -

description -

Throws:

org.openmdx.base.exception.ServiceException

createLead

public Lead createLead(Account account,
                       String name,
                       String description,
                       String nextStep,
                       Lead basedOn)
                throws org.openmdx.base.exception.ServiceException

Deprecated. use contract creators instead

Create lead for given account.

Parameters:

account -

name -

description -

nextStep -

basedOn -

Returns:

Throws:

org.openmdx.base.exception.ServiceException

createOpportunity

public Opportunity createOpportunity(Account account,
                                     String name,
                                     String description,
                                     String nextStep,
                                     Opportunity basedOn)
                              throws org.openmdx.base.exception.ServiceException

Deprecated. use contract creators instead

Create opportunity for given account.

Parameters:

account -

name -

description -

nextStep -

basedOn -

Returns:

Throws:

org.openmdx.base.exception.ServiceException

createQuote

public Quote createQuote(Account account,
                         String name,
                         String description,
                         Quote basedOn)
                  throws org.openmdx.base.exception.ServiceException

Deprecated. use contract creators instead

Create quote for given account.

Parameters:

account -

name -

description -

basedOn -

Returns:

Throws:

org.openmdx.base.exception.ServiceException

createSalesOrder

public SalesOrder createSalesOrder(Account account,
                                   String name,
                                   String description,
                                   SalesOrder basedOn)
                            throws org.openmdx.base.exception.ServiceException

Deprecated. use contract creators instead

Create sales order for given account.

Parameters:

account -

name -

description -

basedOn -

Returns:

Throws:

org.openmdx.base.exception.ServiceException

createInvoice

public Invoice createInvoice(Account account,
                             String name,
                             String description,
                             Invoice basedOn)
                      throws org.openmdx.base.exception.ServiceException

Deprecated. use contract creators instead

Create invoice for given account.

Parameters:

account -

name -

description -

basedOn -

Returns:

Throws:

org.openmdx.base.exception.ServiceException

updateAccountFullName

public void updateAccountFullName(Account account)
                           throws org.openmdx.base.exception.ServiceException

Update derived attribute full name of given account.

Parameters:

account -

Throws:

org.openmdx.base.exception.ServiceException

updatePostalAddressLine

public void updatePostalAddressLine(Account account)
                             throws org.openmdx.base.exception.ServiceException

Update postal address lines which are derived from account information. Override this method for custom-specific behavior. The default implementation updates address lines of the form [salutation, firstName " " lastName] and [firstName " " lastName].

Parameters:

account -

Throws:

org.openmdx.base.exception.ServiceException

updateAssignedAddresses

public void updateAssignedAddresses(AccountAddress address)
                             throws org.openmdx.base.exception.ServiceException

Update the addresses assigned to the given address. The default implementation amends matching postal addresses. Override this method for custom-specific behavior.

Parameters:

address -

Throws:

org.openmdx.base.exception.ServiceException

updateAccount

protected void updateAccount(Account account)
                      throws org.openmdx.base.exception.ServiceException

Update derived attributes of given account. E.g. invoked by jdoPreStore().

Parameters:

account -

Throws:

org.openmdx.base.exception.ServiceException

updateAddress

protected void updateAddress(AccountAddress address)
                      throws org.openmdx.base.exception.ServiceException

Update derived attributes of given address.

Parameters:

address -

Throws:

org.openmdx.base.exception.ServiceException

removeAddress

protected void removeAddress(AccountAddress address,
                             boolean preDelete)
                      throws org.openmdx.base.exception.ServiceException

Callback when address is removed, e.g. jdoPreDelete.

Parameters:

address -

preDelete -

Throws:

org.openmdx.base.exception.ServiceException

countFilteredAccount

public int countFilteredAccount(AbstractFilterAccount accountFilter)
                         throws org.openmdx.base.exception.ServiceException

Count accounts matching the account filter.

Parameters:

accountFilter -

Returns:

Throws:

org.openmdx.base.exception.ServiceException

getAccountSegment

public Segment getAccountSegment(javax.jdo.PersistenceManager pm,
                                 String providerName,
                                 String segmentName)

Get account segment.

Parameters:

pm -

providerName -

segmentName -

Returns:

lookupEmailAddress

public List<EMailAddress> lookupEmailAddress(javax.jdo.PersistenceManager pm,
                                             String providerName,
                                             String segmentName,
                                             String emailAddress)

Find email addresses matching the given pattern.

Parameters:

pm -

providerName -

segmentName -

emailAddress -

Returns:

lookupEmailAddress

public List<EMailAddress> lookupEmailAddress(javax.jdo.PersistenceManager pm,
                                             String providerName,
                                             String segmentName,
                                             String emailAddress,
                                             boolean exactCaseInsensitiveOnly)

Find email addresses matching the given pattern.

Parameters:

pm -

providerName -

segmentName -

emailAddress -

exactCaseInsensitiveOnly -

Returns:

getUnassignableAddressesHolder

public Account getUnassignableAddressesHolder(Segment accountSegment)
                                       throws org.openmdx.base.exception.ServiceException

Get holder for new addresses which can not be automatically be assigned to an account.

Parameters:

accountSegment -

Returns:

Throws:

org.openmdx.base.exception.ServiceException

lookupEmailAddress

public List<EMailAddress> lookupEmailAddress(javax.jdo.PersistenceManager pm,
                                             String providerName,
                                             String segmentName,
                                             String email,
                                             boolean exactCaseInsensitiveOnly,
                                             boolean forceCreate)
                                      throws org.openmdx.base.exception.ServiceException

Find email addresses matching the given pattern. Create the address if it does not exist.

Parameters:

pm -

providerName -

segmentName -

email -

exactCaseInsensitiveOnly -

forceCreate -

Returns:

Throws:

org.openmdx.base.exception.ServiceException

getAccountAddresses

public List<AccountAddress> getAccountAddresses(Account account,
                                                short usage)

Get addresses of given account.

Parameters:

account -

usage -

Returns:

getPrimaryBusinessEMail

public String getPrimaryBusinessEMail(Account account,
                                      String hint)
                               throws org.openmdx.base.exception.ServiceException

Get primary business email address.

Parameters:

account -

hint -

Returns:

Throws:

org.openmdx.base.exception.ServiceException

getPrimaryBusinessPhone

public String getPrimaryBusinessPhone(Account account)
                               throws org.openmdx.base.exception.ServiceException

Get primary business phone of given account.

Parameters:

account -

Returns:

Throws:

org.openmdx.base.exception.ServiceException

getMainAddresses

public AccountAddress[] getMainAddresses(Account account)

Same as getMainAddresses(account, false)

Parameters:

account -

Returns:

main addresses of account

getMainAddresses

public AccountAddress[] getMainAddresses(Account account,
                                         boolean strict)

Return main home and business addresses of given account. If strict is true then address.isMain() is true for all returned addresses. If strict is false then non-main addresses are returned in case a main address with the same type and usage does exist.

Parameters:

account -

strict -

Returns:

array with elements {web home, web business, phone home, phone business, fax home, fax, business, postal home, postal business, mail home, mail business, mobile, phone other, mail other}

getAccountAddresses

public AccountAddress[] getAccountAddresses(Account account,
                                            Accounts.AddressFilter addressFilter,
                                            boolean strict)

Return home and business addresses of given account matching the specified address filter. If strict is true then address.isMain() is true for all returned addresses. If strict is false then non-main addresses are returned in case a main address with the same type and usage does exist.

Parameters:

account -

addressFilter -

strict -

Returns:

array with elements {web home, web business, phone home, phone business, fax home, fax, business, postal home, postal business, mail home, mail business, mobile, phone other, mail other}

updateVcard

public void updateVcard(Account account)
                 throws org.openmdx.base.exception.ServiceException

Update VCARD of given account.

Parameters:

account -

Throws:

org.openmdx.base.exception.ServiceException

updateMember

protected void updateMember(Member member)
                     throws org.openmdx.base.exception.ServiceException

Update member callback. E.g. invoked by jdoPreDelete().

Parameters:

member -

Throws:

org.openmdx.base.exception.ServiceException

countFilteredAddress

public int countFilteredAddress(AbstractFilterAddress addressFilter)
                         throws org.openmdx.base.exception.ServiceException

Count addresses matching the given filter.

Parameters:

addressFilter -

Returns:

Throws:

org.openmdx.base.exception.ServiceException

moveAddressToAccount

public int moveAddressToAccount(AccountAddress source,
                                Account targetAccount,
                                Date updateRelationshipsSince,
                                Date updateRelationshipsBefore)
                         throws org.openmdx.base.exception.ServiceException

Move address to target account. The new address is created and cloned on the target account. The existing address is set to disabled. In addition replaces all references to the old addresses with the new address.

Parameters:

source -

targetAccount -

updateRelationshipsSince -

updateRelationshipsBefore -

Returns:

Throws:

org.openmdx.base.exception.ServiceException

moveAddress

public int moveAddress(AccountAddress source,
                       AccountAddress target,
                       Date updateRelationshipsSince,
                       Date updateRelationshipsBefore)
                throws org.openmdx.base.exception.ServiceException

Replace all references to the source address with the target address.

Parameters:

source -

target -

updateRelationshipsSince -

updateRelationshipsBefore -

Returns:

Throws:

org.openmdx.base.exception.ServiceException

checkForAutoUpdate

public CheckForAutoUpdateResult checkForAutoUpdate(AccountAddress address)

Check whether address qualifies for auto-update.

Parameters:

address -

Returns:

removeAccount

protected void removeAccount(Account account,
                             boolean preDelete)
                      throws org.openmdx.base.exception.ServiceException

Callback for removing an account. E.g. called by jdoPreDelete().

Parameters:

account -

preDelete -

Throws:

org.openmdx.base.exception.ServiceException

getMatchingAccounts

public List<Account> getMatchingAccounts(Segment accountSegment,
                                         AccountQuery accountQuery,
                                         String fullName,
                                         String firstName,
                                         String lastName,
                                         String aliasName,
                                         String phoneNumberMobile,
                                         String phoneNumberHome,
                                         String phoneNumberBusiness,
                                         String postalCityHome,
                                         String postalCityBusiness,
                                         List<String> postalStreetHome,
                                         List<String> postalStreetBusiness,
                                         String emailHome,
                                         String emailBusiness)
                                  throws org.openmdx.base.exception.ServiceException

Get matching contacts.

Parameters:

accountSegment -

accountQuery -

firstName -

lastName -

aliasName -

phoneNumberMobile -

phoneNumberHome -

phoneNumberBusiness -

postalCityHome -

postalCityBusiness -

postalStreetHome -

postalStreetBusiness -

emailHome -

emailBusiness -

Returns:

Throws:

org.openmdx.base.exception.ServiceException

preDelete

public void preDelete(org.openmdx.base.accessor.jmi.cci.RefObject_1_0 object,
                      boolean preDelete)
               throws org.openmdx.base.exception.ServiceException

Description copied from class: AbstractImpl

Pre-delete callback. This method is called before can object is deleted. Override this method for custom-specific behaviour.

Overrides:

preDelete in class AbstractImpl

Throws:

org.openmdx.base.exception.ServiceException

preStore

public void preStore(org.openmdx.base.accessor.jmi.cci.RefObject_1_0 object)
              throws org.openmdx.base.exception.ServiceException

Description copied from class: AbstractImpl

Pre-store callback. This method is called before an object is made persistent. Override this method for custom-specific behaviour.

Overrides:

preStore in class AbstractImpl

Throws:

org.openmdx.base.exception.ServiceException