Constructor Detail

• OfferMediator

  public OfferMediator()
  

Method Detail

• transform

  protected void transform(java.lang.Object priceListObj,
               boolean deleteFlag)
                    throws DataLoadException
  

  Transforms the price list logical noun to a list of physical objects.

  The transformed data object is created and transferred externally using AbstractBusinessObjectMediator.createBaseTableDataObjectWithUniqueIndex(String, Map).

  1. If deleteFlag is true, offer in the PriceList noun that still exist in the database will be deleted or marked for delete.
  2. The next step depends on the dataLoadMode configuration value retrieved by calling AbstractBusinessObjectMediator.getDataLoadMode():
     • If dataLoadMode is Replace, offers that exist in the database will be updated, according to PriceList noun.
     • If dataLoadMode is not Replace and not null, offers will be added according to the PriceList noun.
     • If dataLoadMode is null, this method will return immediately.

  Specified by:

  transform in class AbstractBusinessObjectMediator

  Parameters:

  priceListObj - The PriceList noun to transform. The runtime type be a PriceListType. Cannot be null.

  deleteFlag - True indicates to delete the offers that are related with current logical noun PriceListType before populating, false indicates not to delete.

  Throws:

  DataLoadException - If an error occurs when deleting, replacing, or populating an offer.

  See Also:

  deleteOffer(PriceListType), replaceOffer(PriceListType), populateOFFER(PriceListType), AbstractBusinessObjectMediator.transform(java.lang.Object, boolean)

• populateOFFER

  protected TableDataObject populateOFFER(com.ibm.commerce.price.facade.datatypes.PriceEntryType priceEntry,
                              java.lang.String aCatEntryId,
                              java.lang.String aPriceListId)
                                   throws DataLoadException
  

  Creates and populates the physical data object intended for the OFFER table from the PriceEntry logical object.

  The object is created and transferred externally using AbstractBusinessObjectMediator.createBaseTableDataObjectWithUniqueIndex(String, Map).

  Data for the OFFER table is obtained by using the PriceList noun to find the PriceEntry. The table and column data for the OFFER table are put in a TableDataObject. Physical data objects for OFFERPRICE and OFFERDESC tables are also created and populated.

  Parameters:

  priceEntry - The PriceList noun which is used to populate the TableDataObject. Cannot be null.

  aCatEntryId - The catalog entry ID to associate with the priceEntry in the TableDataObject. Cannot be null.

  aPriceListId - The price list ID to associate with the priceEntry in the TableDataObject. Cannot be null.

  Returns:

  A TableDataObject that contains data for the OFFER table or null if the TableDataObject could not be created or populated.

  Throws:

  DataLoadException - If any of the following occurs:

  • An error occurs when creating a TableDataObject
  • An error occurs when populating OFFERPRICE or OFFERDESCRIPTION table

  See Also:

  populateOFFERPRICE(PriceEntryType, String), populateOFFERDESCRIPTION(PriceEntryType, String)

• populateOFFER

  protected void populateOFFER(com.ibm.commerce.price.facade.datatypes.PriceListType priceListNoun)
                        throws DataLoadException
  

  Creates and populates a physical data object intended for the OFFER table from the PriceList logic object.

  The table and column data for the OFFER table are contained in a TableDataObject. This object is created and transferred externally using AbstractBusinessObjectMediator.createBaseTableDataObjectWithUniqueIndex(String, Map).

  If the catalog entry ID from priceListNoun is null, an exception will be thrown. If PriceListID is null, the ID of the default price list will be used instead.

  Parameters:

  priceListNoun - The PriceList noun which contains data to add to the OFFER table. Cannot be null.

  Throws:

  DataLoadException - If any of the following occurs:

  • Failed to resolve PriceListId
  • Failed to resolve CatentryId
  • Failed to get default price list id
  • Failed to populate the offers

• populateOFFERDESCRIPTION

  protected TableDataObject populateOFFERDESCRIPTION(com.ibm.commerce.price.facade.datatypes.PriceEntryType priceEntry,
                                         java.lang.String offerId)
  

  Creates and populates the table data object intended for the OFFERDESC from the priceEntry logic object.

  The table and column data for the OFFERDESC table are contained in a TableDataObject. This object is created and transferred externally using AbstractBusinessObjectMediator.createBaseTableDataObjectWithUniqueIndex(String, Map).

  The method contains some steps to obtain value for each column of OFFERDESC table. The table and column data for the OFFER table are contained in a TableDataObject.

  Parameters:

  priceEntry - The priceEntry of PriceList logical noun which contains data to add to OFFERDESC table. Cannot be null.

  offerId - The value of column OFFER_ID in table OFFER. It is a unique key, automatically generated when a new OFFER data object is created. Cannot be null.

  Returns:

  A TableDataObject that contains data of the table OFFERDESC or null if failed to create or populate a data object.

• populateOFFERPRICE

  protected void populateOFFERPRICE(com.ibm.commerce.price.facade.datatypes.PriceEntryType priceEntry,
                        java.lang.String offerId)
                             throws DataLoadException
  

  Creates and populates the table data object intended for the OFFERPRICE table from the priceEntry logic object.

  The table and column data for the OFFERPRICE table are contained in a TableDataObject. This object is created and transferred externally using AbstractBusinessObjectMediator.createBaseTableDataObjectWithUniqueIndex(String, Map).

  The method contains some steps to obtain value for each column of OFFERPRICE table from PriceEntry in PriceList noun. The table and column data for the OFFER table are contained in a TableDataObject.

  The method first deals with primary price, then deals with alternative currency price.

  Parameters:

  priceEntry - The priceEntry of PriceList logical noun which contains data to add to OFFERDESC table. Cannot be null.

  offerId - The value of column OFFER_ID in the OFFER table. It is a unique key, automatically generated when a new OFFER data object is created. Cannot be null.

  Throws:

  DataLoadException - If an error occurs when creating or populating the table data object.

  See Also:

  populateOfferPriceForCurrency(MonetaryAmountType, boolean, String)

• populateOfferPriceForCurrency

  protected TableDataObject populateOfferPriceForCurrency(MonetaryAmountType monetaryAmount,
                                              boolean isPrimaryCurrency,
                                              java.lang.String offerId)
                                                   throws DataLoadException
  

  Creates and populates the table data object intended for OFFERPRICE table from the monetaryAmount logic object.

  The table and column data for the OFFERPRICE table are contained in a TableDataObject. This object is created and transferred externally using AbstractBusinessObjectMediator.createBaseTableDataObjectWithUniqueIndex(String, Map).

  Note that the currency in business context will be retrieved when currency from monetaryAmount is null and isPrimaryCurrency is true.

  Parameters:

  monetaryAmount - The value and currency of this offer. Cannot be null.

  isPrimaryCurrency - True indicates the currency is primary currency of this offer, false indicates not.

  offerId - The value of column OFFER_ID in table OFFER. It is a unique key, automatically generated when a new OFFER data object is created. Cannot be null.

  Returns:

  A TableDataObject that contains data of database table OOFERPRICE or null if any of the following occurs:

  • isPrimaryCurrency is false when currency retrieved from monetaryAmount is null
  • the currency retrieved from business context is null when isPrimaryCurrency is true, when currency retrieved from monetaryAmount is null

  Throws:

  DataLoadException - If an error occurs when checking the column value to see if it exceeds the column size.

  See Also:

  MonetaryAmountType

• deleteOffer

  protected void deleteOffer(java.lang.String catalogEntryId,
                 java.lang.String priceListId,
                 java.lang.String identifier)
                      throws DataLoadException
  

  Deletes the offers from OFFER table and related tables physically.

  If identifier is not null, the offers will be deleted from OFFER table by catalogEntryId and priceListId and identifier, or else by catalogEntryId and priceListId.

  Note that this method cannot be called before init() because all SQL statements needed are initialized in init().

  Parameters:

  catalogEntryId - The catalog entry ID from the PriceList noun. Cannot be null.

  priceListId - The price list ID from the PriceList noun. Cannot be null.

  identifier - A String that uniquely identifies this Offer along with the specified catalog entry and price list. It is the same as the identifier used when creating the offer in the offer data source file which is always a CSV file.

  Throws:

  DataLoadException - If an error occurs when setting a long value in DBPreparedStatement.

• markOfferForDelete

  protected void markOfferForDelete(java.lang.String catalogEntryId,
                        java.lang.String priceListId,
                        java.lang.String identifier)
                             throws DataLoadException
  

  Marks the offers as deleted.

  Note that this method will be called when isMarkOfferForDelete is true. If identifier is not null, the offer will be updated in OFFER table by catalogEntryId and priceListId and identifier, or else by catalogEntryId and priceListId.

  Parameters:

  catalogEntryId - The catalog entry ID from the PriceList logic noun. Cannot be null.

  priceListId - The price list ID from the PriceList logic noun. Cannot be null.

  identifier - A String that uniquely identifies this Offer along with the specified catalog entry and price list. It is the same as the identifier used when creating the offer in the offer data source file which is always a CSV file.

  Throws:

  DataLoadException - If an error occurs when setting a long value in DBPreparedStatement.

• replaceOffer

  protected void replaceOffer(com.ibm.commerce.price.facade.datatypes.PriceListType priceListNoun)
                       throws DataLoadException
  

  Creates and populates physical data object intended for the OFFER table from the PriceList logic object in replace mode.

  The table and column data for the OFFER table are contained in a TableDataObject. This object is created and transferred externally using AbstractBusinessObjectMediator.createBaseTableDataObjectWithUniqueIndex(String, Map).

  1. This method is the same as populateOFFER(PriceListType) if the offer has been replaced in the same data load session.
• If the offer has not been replaced yet:
  • if there is only one offer item in database, that offer will be replaced.
  • if there are more than one items of the same offer in database, the items will be deleted or marked as deleted, which depends on isMarkOfferForDelete.
  Then, populateOFFER(PriceListType) will be called to continue offers populating, and the populated offers will be marked as already replaced offers.