BusinessObjectMediator

All Known Implementing Classes:

AbstractBaseCatalogMediator, AbstractBasePageLayoutMediator, AbstractBusinessObjectMediator, AbstractBusinessObjectTransformMediator, AbstractCatalogEntryMediator, com.ibm.commerce.catalogfilter.dataload.mediator.AbstractCatalogFilterMediator, AbstractCatalogGroupMediator, AbstractExpectedInventoryMediator, AbstractFolderItemMediator, AbstractInventoryMediator, AbstractMarketingMediator, AbstractMemberMediator, com.ibm.commerce.foundation.dataload.businessobjectmediator.AbstractObjectTransformMediator, AbstractPageLayoutMediator, AbstractPageMediator, AbstractPriceBaseMediator, AbstractWidgetDefinitionMediator, AttachmentAssetLanguageMediator, AttachmentAssetMediator, AttachmentDescriptionMediator, AttachmentMediator, AttributeDictionaryAttributeFolderRelationshipMediator, AttributeDictionaryAttributeMediator, AttributeDictionaryAttributeSearchIndexMediator, BusinessObjectToCSVTransformMediator, CatalogDescriptionMediator, CatalogEntryAssociationMediator, CatalogEntryAttributeDictionaryAttributeExtendedMediator, CatalogEntryAttributeDictionaryAttributeMediator, CatalogEntryAttributeExtendedMediator, CatalogEntryAttributeMediator, CatalogEntryCalculationCodeMediator, CatalogEntryDescriptionMediator, CatalogEntryDescriptionOverrideMediator, CatalogEntryKitComponentMediator, CatalogEntryMediator, CatalogEntryParentCatalogGroupMediator, CatalogEntryParentProductMediator, CatalogEntrySearchIndexMediator, CatalogEntrySEOMediator, CatalogFilterCategorySelectionMediator, CatalogFilterCatentrySelectionMediator, CatalogFilterConditionGroupMediator, CatalogFilterConditionMediator, CatalogFilterMediator, CatalogGroupAssociationMediator, CatalogGroupCalculationCodeMediator, CatalogGroupDescriptionMediator, CatalogGroupMediator, CatalogGroupRelationshipMediator, CatalogGroupRelationshipSearchIndexMediator, CatalogGroupSearchIndexMediator, CatalogGroupSEOMediator, CatalogMediator, DefaultOfferMediator, ExpectedInventoryDetailMediator, ExpectedInventoryMediator, FulfillmentPropertyMediator, InventoryReceiptMediator, LayoutAssignmentMediator, LayoutMediator, MarketingActivityMediator, MarketingCampaignMediator, MarketingContentAttachmentDescriptionMediator, MarketingContentAttachmentMediator, MarketingContentDescriptionMediator, MarketingContentImageMapMediator, MarketingContentMediator, MarketingElementMediator, MarketingElementNVPMediator, MarketingSpotDefaultContentMediator, MarketingSpotDefaultTitleMediator, MarketingSpotMediator, MemberGroupDescriptionMediator, MemberGroupMediator, MemberGroupMemberMediator, NonATPInventoryMediator, OfferMediator, OrganizationAddressBookMediator, OrganizationAttributeValueMediator, OrganizationMediator, PageMediator, PersonAddressBookMediator, PersonAttributeValueMediator, PersonMediator, PriceListMediator, PromotionDOMMediator, PromotionToDomTransformMediator, RegisterWidgetDefDescMediator, RegisterWidgetDefMediator, SeoPageDescMediator, SeoPageMediator, SubscribeWidgetDefinitionMediator, TableObjectMediator, WidgetMediator, WidgetNVPMediator, WidgetSlotsMediator
```
public interface BusinessObjectMediator
```
The main function of a business object mediator is to call ID resolver to resolve keys and also determine whether it is a new object or an existing object.

The business object mediator will call the configured DataWriter to write the data out to the data store.

The business object builder will call the business object mediator in the following sequence:
1. init() - initialize the business object mediator.
2. For each populated data object, call the following methods:
  1. preProcess() - Pre-process the data.
  2. execute() - Resolve the ID in the data object and call the DataWriter.insert() or DataWriter.update() to write out the data.
  3. postProcess() - Post process the data.
3. close() - Close the business object mediator.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String COPYRIGHT
The internal copyright field.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COPYRIGHT` The internal copyright field.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`close()` This method will perform cleanup on the business object mediator.
`void`	`execute(java.lang.Object obj)` This method will resolve identifiers for the populated data object and call the configured data writer to write the data out to the data store.
`ConfigProperties`	`getConfigProperties()` Returns the instance of the `ConfigProperties` of the `BusinessObjectWriter`.
`void`	`init()` This method performs some initialization for the business object mediator.
`ConfigProperties`	`initConfig(org.w3c.dom.Node businessObjectMediatorNode, ConfigProperties parentConfigProperties)` This method parses the `BusinessObjectMediator` xml node read in from the business object configuration file and stores the configuration in memory.
`void`	`postProcess()` This method performs any post processing of the data after the data has been written to the data store.
`void`	`preProcess(java.lang.Object obj)` This method performs any pre-processing of the data if needed.
`void`	`setConfigProperties(ConfigProperties aConfigProperties)` Sets the configuration properties for this business object mediator.

- Field Detail
  - COPYRIGHT
```
static final java.lang.String COPYRIGHT
```
    The internal copyright field.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getConfigProperties
```
ConfigProperties getConfigProperties()
```
    Returns the instance of the ConfigProperties of the BusinessObjectWriter.
    
    Call this method when you need to get specific properties from the configuration properties.
    
    Returns:
    
    The configuration properties for this business object mediator.
  - setConfigProperties
```
void setConfigProperties(ConfigProperties aConfigProperties)
```
    Sets the configuration properties for this business object mediator.
    
    This method is not normally called unless overriding the configuration properties for this business object mediator is required.
    
    Parameters:
    
    aConfigProperties - The configuration properties for this business object mediator.
  - init
```
void init()
   throws DataLoadException
```
    This method performs some initialization for the business object mediator.
    
    Throws:
    
    DataLoadException - An application exception will be thrown if there was a problem initializing the business object mediator.
  - initConfig
```
ConfigProperties initConfig(org.w3c.dom.Node businessObjectMediatorNode,
                            ConfigProperties parentConfigProperties)
                     throws DataLoadException
```
    This method parses the BusinessObjectMediator xml node read in from the business object configuration file and stores the configuration in memory.
    
    Parameters:
    
    businessObjectMediatorNode - The BusinessObjectMediator xml node read in from the business object configuration file.
    
    parentConfigProperties - The configuration properties for the parent business object builder of this data reader.
    
    Returns:
    
    ConfigProperties The initialized configuration for this business object mediator.
    
    Throws:
    
    DataLoadException - An application exception will be thrown if there was a problem initializing the configuration for the business object mediator.
  - preProcess
```
void preProcess(java.lang.Object obj)
         throws DataLoadException
```
    This method performs any pre-processing of the data if needed.
    
    This method normally does not have any function. Implement this method only if any pre-processing of the populated data object is needed.
    
    Parameters:
    
    obj - The data object data load with input data read in from the data reader.
    
    Throws:
    
    DataLoadException - An application exception will be thrown is there was a problem preproccessing the data from the data object.
  - execute
```
void execute(java.lang.Object obj)
      throws DataLoadException
```
    This method will resolve identifiers for the populated data object and call the configured data writer to write the data out to the data store.
    
    Parameters:
    
    obj - The populated and pre-processed data object.
    
    Throws:
    
    DataLoadException - An application exception will be thrown is there was a problem resolving the IDs or writing the data.
  - postProcess
```
void postProcess()
          throws DataLoadException
```
    This method performs any post processing of the data after the data has been written to the data store.
    
    This method normally does not have any function. Implement this method only if any post processing of the data loaded is needed.
    
    Throws:
    
    DataLoadException - An application exception will be thrown is there was a problem post processing the loaded data.
  - close
```
void close()
    throws DataLoadException
```
    This method will perform cleanup on the business object mediator. It will attempt to close all of the data writers configured for this business object mediator.
    
    Throws:
    
    DataLoadException - An application exception will be thrown if there was a problem closing the business object mediator or its data writers.

COPYRIGHT

getConfigProperties

setConfigProperties

init

initConfig

preProcess

execute

postProcess

close