com.softslate.commerce.businessobjects.core
Class BaseBusinessProcessor

java.lang.Object
  com.softslate.commerce.businessobjects.core.BaseBusinessObject
      com.softslate.commerce.businessobjects.core.BaseBusinessProcessor

All Implemented Interfaces:

BusinessObject, BusinessProcessor

Direct Known Subclasses:

BasePaymentProcessor, BaseShippingProcessor, BaseTaxProcessor, BasicAdministratorProcessor, BasicAdminPaymentProcessor, BasicAttributeProcessor, BasicCartProcessor, BasicCategoryProcessor, BasicCategorySettingProcessor, BasicCountryProcessor, BasicCustomerAddressProcessor, BasicCustomerProcessor, BasicNPOProcessor, BasicOptionProcessor, BasicOrderDeliveryProcessor, BasicOrderItemAttributeProcessor, BasicOrderItemProcessor, BasicOrderProcessor, BasicProductProcessor, BasicProductSettingProcessor, BasicRoleProcessor, BasicShippingMethodProcessor, BasicShippingRateProcessor, BasicSKUProcessor, BasicStateProcessor, BasicTaxRateProcessor, InstallerProcessor, UpgradesProcessor

public abstract class BaseBusinessProcessor

extends BaseBusinessObject

implements BusinessProcessor

Abstract superclass for all objects in the business layer.

The methods provided allow implementations to communicate with other elements of the application. In particular, retrieve settings (using getSettingsBean()), retrieve user information (using getUser()), create data access objects (using getDaoFactory()) and create other business objects (using getBusinessObjectFactory()).

Author:

David Tobey

Field Summary

private BusinessObjectFactory	businessObjectFactory
private DAOFactory	daoFactory
(package private) static org.apache.commons.logging.Log	log
private SettingsBean	settingsBean
private User	user

Constructor Summary

BaseBusinessProcessor()

Method Summary

java.lang.String	formatPrice(double rawPrice)
BusinessObjectFactory	getBusinessObjectFactory() Retrieves the BusinessObjectFactory previously set for this business object.
DAOFactory	getDaoFactory() Retrieves the DAOFactory previously set for this business object.
SettingsBean	getSettingsBean() Retrieves the SettingsBean previously set for this business object.
User	getUser() Retrieves the User previously set for this business object.
void	initialize(java.util.Map transferMap) Initializes this business object by copying incoming parameters into its properties.
void	setBusinessObjectFactory(BusinessObjectFactory businessObjectFactory) Sets this business object's BusinessObjectFactory.
void	setDaoFactory(DAOFactory daoFactory) Sets this business object's DAOFactory.
void	setSettingsBean(SettingsBean settingsBean) Sets this business object's SettingsBean.
void	setUser(User user) Sets this business object's User.

Methods inherited from class com.softslate.commerce.businessobjects.core.BaseBusinessObject

formatDateTime, parseDateTime, prepareRequestData, sendHTTPPost

Methods inherited from class java.lang.Object

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

Field Detail

log

static org.apache.commons.logging.Log log

settingsBean

private SettingsBean settingsBean

user

private User user

daoFactory

private DAOFactory daoFactory

businessObjectFactory

private BusinessObjectFactory businessObjectFactory

Constructor Detail

BaseBusinessProcessor

public BaseBusinessProcessor()

Method Detail

getSettingsBean

public SettingsBean getSettingsBean()

Description copied from interface: BusinessProcessor

Retrieves the SettingsBean previously set for this business object.

Specified by:

getSettingsBean in interface BusinessProcessor

Returns:

A SettingsBean object that represents various settings for the system.

setSettingsBean

public void setSettingsBean(SettingsBean settingsBean)

Description copied from interface: BusinessProcessor

Sets this business object's SettingsBean. Used by the application's BusinessObjectFactory (through initialize(Map parameters)), to provide the system's SettingsBean to this business object.

Specified by:

setSettingsBean in interface BusinessProcessor

Parameters:

settingsBean - The current SettingsBean for the system, containing various settings to be used by this business object.

getUser

public User getUser()

Description copied from interface: BusinessProcessor

Retrieves the User previously set for this business object.

Specified by:

getUser in interface BusinessProcessor

Returns:

A User object that represents the user currently accessing the system.

setUser

public void setUser(User user)

Description copied from interface: BusinessProcessor

Sets this business object's User. Used by the application's BusinessObjectFactory (through initialize(Map parameters)), to provide the current User accessing the system to this business object.

Specified by:

setUser in interface BusinessProcessor

Parameters:

user - The current User accessing the system, for which business processing is to be performed by this business object.

getDaoFactory

public DAOFactory getDaoFactory()

Description copied from interface: BusinessProcessor

Retrieves the DAOFactory previously set for this business object.

Specified by:

getDaoFactory in interface BusinessProcessor

Returns:

A DAOFactory object that can be used to create data access objects.

setDaoFactory

public void setDaoFactory(DAOFactory daoFactory)

Description copied from interface: BusinessProcessor

Sets this business object's DAOFactory. Used by the application's BusinessObjectFactory (through initialize(Map parameters)), to provide the current DAOFactory for the system to this business object.

Specified by:

setDaoFactory in interface BusinessProcessor

Parameters:

daoFactory - The current DAOFactory for the system, which will allow this business object to create data access objects.

getBusinessObjectFactory

public BusinessObjectFactory getBusinessObjectFactory()

Description copied from interface: BusinessProcessor

Retrieves the BusinessObjectFactory previously set for this business object.

Specified by:

getBusinessObjectFactory in interface BusinessProcessor

Returns:

A BusinessObjectFactory object that can be used to create other business objects.

setBusinessObjectFactory

public void setBusinessObjectFactory(BusinessObjectFactory businessObjectFactory)

Description copied from interface: BusinessProcessor

Sets this business object's BusinessObjectFactory. Used by the application's BusinessObjectFactory (through initialize(Map parameters)), to provide itself to this business object, so that it can create other business objects in turn.

Specified by:

setBusinessObjectFactory in interface BusinessProcessor

Parameters:

businessObjectFactory - The current BusinessObjectFactory for the system, allowing this business object to create other business objects.

initialize

public void initialize(java.util.Map transferMap)
                throws java.lang.Exception

Description copied from interface: BusinessObject

Initializes this business object by copying incoming parameters into its properties. This method is used by BusinessObjectFactory after object creation.

Specified by:

initialize in interface BusinessObject

Overrides:

initialize in class BaseBusinessObject

Throws:

java.lang.Exception

formatPrice

public java.lang.String formatPrice(double rawPrice)