com.softslate.commerce.businessobjects.core
Interface BusinessProcessor

All Superinterfaces:
BusinessObject
All Known Subinterfaces:
AdminPaymentProcessor, AttributeProcessor, CategoryProcessor, CategorySettingProcessor, CountryProcessor, CustomerAddressProcessor, DiscountProcessor, DiscountRangeProcessor, ExportProcessor, ImportExportProcessor, ImportProcessor, ManufacturerProcessor, OptionProcessor, OrderDeliveryProcessor, OrderDiscountProcessor, OrderItemAttributeProcessor, OrderItemProcessor, ProductSettingProcessor, RoleProcessor, ShippingRuleProcessor, ShippingRuleRangeProcessor, SKUProcessor, StateProcessor
All Known Implementing Classes:
AbstractNotificationProcessor, AuthorizationAmountNotificationProcessorImpl, AuthorizeNetProcessor, BaseBusinessProcessor, BasePaymentProcessor, BasePayPalNVPProcessor, BaseShippingProcessor, BaseTaxProcessor, BasicAdministratorProcessor, BasicAdminPaymentProcessor, BasicAttributeProcessor, BasicCartDiscountProcessor, BasicCartProcessor, BasicCategoryProcessor, BasicCategorySettingProcessor, BasicCountryProcessor, BasicCustomerAddressProcessor, BasicCustomerProcessor, BasicDiscountProcessor, BasicDiscountRangeProcessor, BasicExportProcessor, BasicImportExportProcessor, BasicImportProcessor, BasicInventoryProcessor, BasicLuceneProcessor, BasicManufacturerProcessor, BasicOptionProcessor, BasicOrderDeliveryProcessor, BasicOrderDiscountProcessor, BasicOrderItemAttributeProcessor, BasicOrderItemProcessor, BasicOrderProcessor, BasicPaymentProcessor, BasicProductProcessor, BasicProductSettingProcessor, BasicRoleProcessor, BasicShippingMethodProcessor, BasicShippingProcessor, BasicShippingRateProcessor, BasicShippingRuleProcessor, BasicShippingRuleRangeProcessor, BasicSKUProcessor, BasicStateProcessor, BasicTaxProcessor, BasicTaxRateProcessor, ChargeAmountNotificationProcessorImpl, ChargebackAmountNotificationProcessorImpl, CheckPaymentProcessor, GoogleCheckoutProcessor, InstallerProcessor, MerchantCalculationCallbackProcessorImpl, NewOrderNotificationProcessorImpl, OrderStateChangeNotificationProcessorImpl, PayflowLinkProcessor, PayflowProACHProcessor, PayflowProProcessor, PayPalDirectProcessor, PayPalExpressProcessor, PayPalUKDirectProcessor, PayPalUKExpressProcessor, RefundAmountNotificationProcessorImpl, RiskInformationNotificationProcessorImpl, SettingBean, SettingsBean, UpgradesProcessor, UPSShippingProcessor, USPSShippingProcessor

public interface BusinessProcessor
extends BusinessObject

A parent interface for all of the other interfaces handling business processing. (Interfaces handling business processing are all named with the suffix "Processor".)

The methods provided here allow implementations to communicate with other elements of the application. In particular, retrieve general settings from the database (using getSettings()), retrive application settings from the /WEB-INF/classes/appSettings.properties file (using getAppSettings(), retrive application components from the /WEB-INF/classes/appComponents.properties file (using getAppComponents(), retrieve user information (using getUser()), create data access objects (using getDaoFactory()) and create other business objects (using getBusinessObjectFactory()).

Author:
David Tobey
See Also:
BaseBusinessProcessor

Method Summary
 java.util.Properties getAppComponents()
          Retrieves this object's application components.
 java.util.Properties getAppSettings()
          Retrieves the application settings previously set for this object.
 BusinessObjectFactory getBusinessObjectFactory()
          Retrieves the BusinessObjectFactory previously set for this business object.
 DAOFactory getDaoFactory()
          Retrieves the DAOFactory previously set for this business object.
 Settings getSettings()
          Retrieves the Settings instance previously set for this business object.
 User getUser()
          Retrieves the User previously set for this business object.
 void setAppComponents(java.util.Properties appComponents)
          Sets this object's application components.
 void setAppSettings(java.util.Properties appSettings)
          Sets this object's application settings.
 void setBusinessObjectFactory(BusinessObjectFactory businessObjectFactory)
          Sets this business object's BusinessObjectFactory.
 void setDaoFactory(DAOFactory daoFactory)
          Sets this business object's DAOFactory.
 void setSettings(Settings settings)
          Sets this business object's Settings instance.
 void setUser(User user)
          Sets this business object's User.
 BusinessObjectUtils utils()
          Retrieves a utility object that provides useful methods for business objects.
 
Methods inherited from interface com.softslate.commerce.businessobjects.core.BusinessObject
initialize
 

Method Detail

getSettings

Settings getSettings()
Retrieves the Settings instance previously set for this business object. The Settings object holds general settings stored in the sscSetting database table.

Returns:
A Settings object that represents various settings for the system.

setSettings

void setSettings(Settings settings)
Sets this business object's Settings instance. Used by the application's BusinessObjectFactory (through initialize(Map parameters)), to provide the system's Settings to this business object.

Parameters:
settings - The current Settings for the system, containing various settings to be used by this business object.

getAppSettings

java.util.Properties getAppSettings()
Retrieves the application settings previously set for this object. The application settings are settings for information unique to a given installation, such as the location of files on the server, as opposed to the Settings interface, which stores settings drawn from the database. They are stored in the /WEB-INF/classes/appSettings.properties file under each installation.

Returns:
A Properties object that represents various settings for the application.

setAppSettings

void setAppSettings(java.util.Properties appSettings)
Sets this object's application settings. The application settings are settings for information unique to a given installation, such as the location of files on the server, as opposed to the Settings interface, which stores settings drawn from the database.

Parameters:
appSettings - The current application settings in effect for the system.

getAppComponents

java.util.Properties getAppComponents()
Retrieves this object's application components. The components identify which Java classes implement the various interfaces used by the system. They are stored in the /WEB-INF/classes/appComponents.properties file under each installation.

Returns:
A Properties object that represents component settings for the application.

setAppComponents

void setAppComponents(java.util.Properties appComponents)
Sets this object's application components. The components identify which Java classes implement the various interfaces used by the system.

Parameters:
appComponents - The current application components in effect for the system.

getUser

User getUser()
Retrieves the User previously set for this business object. In the struts layer, this property corresponds to the "user" attribute of each session.

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

setUser

void setUser(User user)
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. In the struts layer, this property corresponds to the "user" attribute of each session.

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

getDaoFactory

DAOFactory getDaoFactory()
Retrieves the DAOFactory previously set for this business object.

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

setDaoFactory

void setDaoFactory(DAOFactory daoFactory)
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.

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

getBusinessObjectFactory

BusinessObjectFactory getBusinessObjectFactory()
Retrieves the BusinessObjectFactory previously set for this business object.

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

setBusinessObjectFactory

void setBusinessObjectFactory(BusinessObjectFactory businessObjectFactory)
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.

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

utils

BusinessObjectUtils utils()
Retrieves a utility object that provides useful methods for business objects.

Returns:
An implementation of BusinessObjectUtils.


Copyright ? SoftSlate, LLC 2003?2005