com.ibm.commerce.price.facade.server.external

Class ExternalPriceFacadeClient

java.lang.Object

com.ibm.commerce.foundation.client.facade.bod.AbstractBusinessObjectDocumentFacadeClient

com.ibm.commerce.price.facade.client.AbstractPriceFacadeClient

com.ibm.commerce.price.facade.server.external.ExternalPriceFacadeClient

public class ExternalPriceFacadeClient
extends com.ibm.commerce.price.facade.client.AbstractPriceFacadeClient

This class provides methods that client applications can call to access the external price facade.

Field Summary

Fields inherited from class com.ibm.commerce.foundation.client.facade.bod.AbstractBusinessObjectDocumentFacadeClient

CHANGE_VERB_ACTION_ADD, CHANGE_VERB_ACTION_CHANGE, CHANGE_VERB_ACTION_CREATE, CHANGE_VERB_ACTION_DELETE, CHANGE_VERB_ACTION_UPDATE

Constructor Summary

Constructors

Constructor and Description
ExternalPriceFacadeClient() This method creates an instance of the client to communicate with the external price facade.
ExternalPriceFacadeClient(BusinessContextType businessContext, javax.security.auth.callback.CallbackHandler callbackHandler) This method creates an instance of the client to communicate with the external price facade.

Method Summary

Modifier and Type	Method and Description
com.ibm.commerce.price.facade.datatypes.ShowPriceListDataAreaType	checkShowPriceList(com.ibm.commerce.price.facade.datatypes.ShowPriceListDataAreaType showPriceListDataArea) This method will examine the ShowPriceListDataArea to see if there is any error information reported.

Methods inherited from class com.ibm.commerce.price.facade.client.AbstractPriceFacadeClient

changePriceConstant, changePriceEquation, changePriceList, changePriceRule, getDisplayPrice, getDisplayPrice, getDisplayPrice, getEntitledPrice, getEntitledPrice, getEntitledPrice, getPriceConstant, getPriceConstant, getPriceConstant, getPriceEquation, getPriceEquation, getPriceEquation, getPriceList, getPriceList, getPriceList, getPriceRule, getPriceRule, getPriceRule, processPriceConstant, processPriceEquation, processPriceList, processPriceRule, syncPriceList

Methods inherited from class com.ibm.commerce.foundation.client.facade.bod.AbstractBusinessObjectDocumentFacadeClient

createActionExpression, createChangeVerb, createGetVerb, createGetVerb, createProcessVerb, createSyncVerb

Methods inherited from class java.lang.Object

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

Constructor Detail

ExternalPriceFacadeClient

public ExternalPriceFacadeClient()

This method creates an instance of the client to communicate with the external price facade.

ExternalPriceFacadeClient

public ExternalPriceFacadeClient(BusinessContextType businessContext,
                                 javax.security.auth.callback.CallbackHandler callbackHandler)

This method creates an instance of the client to communicate with the external price facade.

Parameters:

businessContext - The default business context to associate with the messages when making requests.

callbackHandler - Used for authentication purposes so the controller can give the authentication information to the transport when required.

Method Detail

checkShowPriceList

public com.ibm.commerce.price.facade.datatypes.ShowPriceListDataAreaType checkShowPriceList(com.ibm.commerce.price.facade.datatypes.ShowPriceListDataAreaType showPriceListDataArea)
                                                                                     throws com.ibm.commerce.price.facade.client.PriceListException

This method will examine the ShowPriceListDataArea to see if there is any error information reported. If there is, then the PriceListException will be thrown to represent the error. This method should be used by those methods that are performing a Process operation on a single PriceList.

Overrides:

checkShowPriceList in class com.ibm.commerce.price.facade.client.AbstractPriceFacadeClient

Parameters:

showPriceListDataArea - The show PriceList data area to inspect.

Returns:

The specified ShowPriceListDataArea if no error information is found.

Throws:

com.ibm.commerce.price.facade.client.PriceListException - The PriceListException is thrown if error information is found in the specified ShowPriceListDataArea. This will represent that there was a problem when performing the operation.