Interface BusinessProcessor
- All Superinterfaces:
BusinessObject
- All Known Subinterfaces:
AddressValidationProcessor
,AdminPaymentProcessor
,AttributeProcessor
,AvaTaxSubscriber
,AvaTaxTrigger
,CapturePaymentSubscriber
,CapturePaymentTrigger
,CartDiscountProcessor
,CartProcessor
,CategoryProcessor
,CategorySettingProcessor
,CountryProcessor
,CustomerAddressProcessor
,CustomerProcessor
,CustomerWishListProcessor
,DiscountProcessor
,DiscountRangeProcessor
,EmailSender
,EventBusRegistrar
,ExportProcessor
,FileStorageProcessor
,ImportExportProcessor
,ImportProcessor
,InventoryNotificationSubscriber
,InventoryNotificationTrigger
,InventoryProcessor
,IPayPalDirectPaymentProcessor
,IPayPalExpressPaymentProcessor
,IPaypointCallbackProcessor
,JsonExclusionStrategy
,LuceneFacetHelper
,LuceneIndexer
,LuceneSearcher
,LuceneSuggestionsIndexer
,LuceneSuggestionsSearcher
,ManufacturerProcessor
,OptionProcessor
,OrderDeliveryProcessor
,OrderDiscountProcessor
,OrderItemAttributeProcessor
,OrderItemProcessor
,OrderProcessor
,OrderSettingProcessor
,OrderShippingRuleProcessor
,OrderStatusEmailNotificationSubscriber
,OrderStatusEmailNotificationTrigger
,PaymentProcessor
,ProductReviewProcessor
,ProductSettingProcessor
,QboConnectionProcessor
,QboOrderProcessor
,QboOrderSubscriber
,QboOrderTrigger
,QboQueryProcessor
,RecaptchaProcessor
,RequestLogProcessor
,RoleProcessor
,SalesReportProcessor
,ShippingRuleProcessor
,ShippingRuleRangeProcessor
,SKUProcessor
,StateProcessor
,TemplateParser
- All Known Implementing Classes:
AbandonedCartEmailJob
,AbstractJob
,AbstractOrderEmailJob
,AuthorizeNetAIMProcessor
,AuthorizeNetAPIProcessor
,AuthorizeNetDPMProcessor
,AvaTaxProcessor
,AvaTaxSubscriberImpl
,AvaTaxTriggerImpl
,BaseBusinessProcessor
,BaseLuceneProcessor
,BasePaymentProcessor
,BasePayPalNVPProcessor
,BaseShippingProcessor
,BaseTaxProcessor
,BaseTrigger
,BasicAdministratorProcessor
,BasicAdminPaymentProcessor
,BasicAttributeProcessor
,BasicCartDiscountProcessor
,BasicCartProcessor
,BasicCategoryProcessor
,BasicCategorySettingProcessor
,BasicCountryProcessor
,BasicCustomerAddressProcessor
,BasicCustomerProcessor
,BasicCustomerWishListProcessor
,BasicDiscountProcessor
,BasicDiscountRangeProcessor
,com.softslate.emailer.businessobjects.core.BasicEmailerProcessor
,BasicEmailOptOutProcessor
,BasicEmailProcessor
,BasicExportProcessor
,BasicImportExportProcessor
,BasicImportProcessor
,BasicInventoryProcessor
,BasicJsonExclusionStrategy
,BasicLuceneFacetHelper
,BasicLuceneIndexer
,BasicLuceneSearcher
,BasicLuceneSuggestionsIndexer
,BasicLuceneSuggestionsSearcher
,BasicManufacturerProcessor
,BasicOptionProcessor
,BasicOrderDeliveryProcessor
,BasicOrderDiscountProcessor
,BasicOrderItemAttributeProcessor
,BasicOrderItemProcessor
,BasicOrderProcessor
,BasicOrderSettingProcessor
,BasicOrderShippingRuleProcessor
,BasicPaymentProcessor
,BasicProductProcessor
,BasicProductReviewProcessor
,BasicProductSettingProcessor
,BasicRecaptchaProcessor
,BasicRequestLogProcessor
,BasicRoleProcessor
,BasicSalesReportProcessor
,BasicShippingMethodProcessor
,BasicShippingProcessor
,BasicShippingRateProcessor
,BasicShippingRuleProcessor
,BasicShippingRuleRangeProcessor
,BasicSKUProcessor
,BasicStateProcessor
,BasicTaxProcessor
,BasicTaxRateProcessor
,BasicTemplateProcessor
,CapturePaymentSubscriberImpl
,CapturePaymentTriggerImpl
,CardInfoCleanUpJob
,CheckPaymentProcessor
,ConstantContactProcessor
,CustomerFollowUpJob
,EmailNotificationTrigger
,EmailSenderImpl
,EventBusRegistrarImpl
,FedExAddressValidationProcessor
,FedExShippingProcessor
,FirstDataProcessor
,IncompleteOrdersJob
,InstallerProcessor
,InventoryNotificationSubscriberImpl
,InventoryNotificationTriggerImpl
,LocalFileStorageProcessor
,MailChimpProcessor
,MonitorJob
,OrderShippedJob
,OrderStatusEmailNotificationSubscriberImpl
,OrderStatusEmailNotificationTriggerImpl
,PayflowLinkProcessor
,PayflowProACHProcessor
,PayflowProProcessor
,PayPalDirectProcessor
,PayPalExpressProcessor
,PayPalUKDirectProcessor
,PayPalUKExpressProcessor
,PaypointCallbackProcessor
,PaypointProcessor
,PurchaseOrderPaymentProcessor
,QboConnectionProcessorImpl
,QboOrderProcessorImpl
,QboOrderSubscriberImpl
,QboOrderTriggerImpl
,QboQueryProcessorImpl
,ReindexLuceneJob
,RequestLogBean
,SettingBean
,SettingsBean
,TemplateParserImpl
,UpgradesProcessor
,UPSShippingProcessor
,USPSShippingProcessor
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:
-
Method Summary
Modifier and TypeMethodDescriptionRetrieves this object's application components.Retrieves the application settings previously set for this object.Retrieves theBusinessObjectFactory
previously set for this business object.Retrieves theDAOFactory
previously set for this business object.com.google.common.eventbus.EventBus
Retrieves theEventBus
previously set for this factory.com.google.inject.Injector
Retrieves theInjector
previously set.Retrieves theSettings
instance previously set for this business object.getUser()
Retrieves theUser
previously set for this business object.void
setAppComponents
(Properties appComponents) Sets this object's application components.void
setAppSettings
(Properties appSettings) Sets this object's application settings.void
setBusinessObjectFactory
(BusinessObjectFactory businessObjectFactory) Sets this business object'sBusinessObjectFactory
.void
setDaoFactory
(DAOFactory daoFactory) Sets this business object'sDAOFactory
.void
setEventBus
(com.google.common.eventbus.EventBus eventBus) Sets this factory'sEventBus
.void
setInjector
(com.google.inject.Injector injector) Sets this object'sInjector
that can be used to create other objects and inject them with dependencies.void
setSettings
(Settings settings) Sets this business object'sSettings
instance.void
Sets this business object'sUser
.utils()
Retrieves a utility object that provides useful methods for business objects.Methods inherited from interface com.softslate.commerce.businessobjects.core.BusinessObject
initialize
-
Method Details
-
getSettings
Settings getSettings()Retrieves theSettings
instance previously set for this business object. TheSettings
object holds general settings stored in thesscSetting
database table.- Returns:
- A
Settings
object that represents various settings for the system.
-
setSettings
Sets this business object'sSettings
instance. Used by the application'sBusinessObjectFactory
(throughinitialize(Map parameters)
), to provide the system'sSettings
to this business object.- Parameters:
settings
- The currentSettings
for the system, containing various settings to be used by this business object.
-
getAppSettings
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 theSettings
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
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 theSettings
interface, which stores settings drawn from the database.- Parameters:
appSettings
- The current application settings in effect for the system.
-
getAppComponents
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
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 theUser
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
Sets this business object'sUser
. Used by the application'sBusinessObjectFactory
(throughinitialize(Map parameters)
), to provide the currentUser
accessing the system to this business object. In the struts layer, this property corresponds to the "user" attribute of each session.- Parameters:
user
- The currentUser
accessing the system, for which business processing is to be performed by this business object.
-
getDaoFactory
DAOFactory getDaoFactory()Retrieves theDAOFactory
previously set for this business object.- Returns:
- A
DAOFactory
object that can be used to create data access objects.
-
setDaoFactory
Sets this business object'sDAOFactory
. Used by the application'sBusinessObjectFactory
(throughinitialize(Map parameters)
), to provide the currentDAOFactory
for the system to this business object.- Parameters:
daoFactory
- The currentDAOFactory
for the system, which will allow this business object to create data access objects.
-
getBusinessObjectFactory
BusinessObjectFactory getBusinessObjectFactory()Retrieves theBusinessObjectFactory
previously set for this business object.- Returns:
- A
BusinessObjectFactory
object that can be used to create other business objects.
-
setBusinessObjectFactory
Sets this business object'sBusinessObjectFactory
. Used by the application'sBusinessObjectFactory
(throughinitialize(Map parameters)
), to provide itself to this business object, so that it can create other business objects in turn.- Parameters:
businessObjectFactory
- The currentBusinessObjectFactory
for the system, allowing this business object to create other business objects.
-
getInjector
com.google.inject.Injector getInjector()Retrieves theInjector
previously set.- Returns:
- A
Injector
object that can be used to create other objects and inject them with dependencies.
-
setInjector
void setInjector(com.google.inject.Injector injector) Sets this object'sInjector
that can be used to create other objects and inject them with dependencies.- Parameters:
injector
- The currentInjector
for the system, which can be used to create other objects and inject them with dependencies.
-
getEventBus
com.google.common.eventbus.EventBus getEventBus()Retrieves theEventBus
previously set for this factory.- Returns:
- A
EventBus
object that can be used to post events and trigger subscribers to run their code.
-
setEventBus
void setEventBus(com.google.common.eventbus.EventBus eventBus) Sets this factory'sEventBus
. This factory will pass theEventBus
to every business object it creates.- Parameters:
eventBus
- The currentEventBus
for the system, which can be used to post events to subscribers
-
utils
BusinessObjectUtils utils()Retrieves a utility object that provides useful methods for business objects.- Returns:
- An implementation of
BusinessObjectUtils
.
-