public abstract class AbstractPromotionFacadeClient extends AbstractBusinessObjectDocumentFacadeClient
This class provides a set of methods that can be used to communicate with the Promotion facade. This class represents a library of Promotion operations that can be performed. The purpose of this class is to hide the details about constructing the business object document that represents the service request into simple Java methods. The complexity of building the request document and making the request is all managed by this client class of the Promotion facade.
CHANGE_VERB_ACTION_ADD, CHANGE_VERB_ACTION_CHANGE, CHANGE_VERB_ACTION_CREATE, CHANGE_VERB_ACTION_DELETE, CHANGE_VERB_ACTION_UPDATE
Constructor and Description |
---|
AbstractPromotionFacadeClient()
Creates an instance of the client to communicate with the Promotion facade.
|
AbstractPromotionFacadeClient(BusinessContextType businessContext,
javax.security.auth.callback.CallbackHandler callbackHandler)
Creates an instance of the client to communicate with the Promotion facade.
|
Modifier and Type | Method and Description |
---|---|
com.ibm.commerce.promotion.facade.datatypes.RespondPromoCodeType |
changePromoCode(com.ibm.commerce.promotion.facade.datatypes.ChangePromoCodeType aChangePromoCode)
This method will communicate with the Promotion facade and send the specified
ChangePromoCode request.
|
RespondPromotionType |
changePromotion(ChangePromotionType aChangePromotion)
This method will communicate with the Promotion facade and send the specified
ChangePromotion request.
|
com.ibm.commerce.promotion.facade.datatypes.ShowPromoCodeType |
getPromoCode(com.ibm.commerce.promotion.facade.datatypes.GetPromoCodeType aGetPromoCode)
This method will communicate with the Promotion facade and send the specified
GetPromoCode request.
|
com.ibm.commerce.promotion.facade.datatypes.ShowPromoCodeDataAreaType |
getPromoCode(GetType getVerb)
This method returns the
ShowPromoCodeDataArea when issuing the specified
get expression to fetch PromoCodes. |
java.util.List |
getPromoCode(java.lang.String expressionLanguage,
java.lang.String expression)
This method returns a list of PromoCodes based on the expression specified.
|
ShowPromotionType |
getPromotion(GetPromotionType aGetPromotion)
This method will communicate with the Promotion facade and send the specified
GetPromotion request.
|
ShowPromotionDataAreaType |
getPromotion(GetType getVerb)
This method returns the
ShowPromotionDataArea when issuing the specified
get expression to fetch Promotions. |
java.util.List |
getPromotion(java.lang.String expressionLanguage,
java.lang.String expression)
This method returns a list of Promotions based on the expression specified.
|
com.ibm.commerce.promotion.facade.datatypes.AcknowledgePromoCodeType |
processPromoCode(com.ibm.commerce.promotion.facade.datatypes.ProcessPromoCodeType aProcessPromoCode)
This method will communicate with the Promotion facade and send the specified
ProcessPromoCode request.
|
AcknowledgePromotionType |
processPromotion(ProcessPromotionType aProcessPromotion)
This method will communicate with the Promotion facade and send the specified
ProcessPromotion request.
|
createActionExpression, createChangeVerb, createGetVerb, createGetVerb, createProcessVerb, createSyncVerb
public AbstractPromotionFacadeClient()
public AbstractPromotionFacadeClient(BusinessContextType businessContext, javax.security.auth.callback.CallbackHandler callbackHandler)
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.public ShowPromotionType getPromotion(GetPromotionType aGetPromotion)
aGetPromotion
- The GetPromotion request document.ShowPromotion
response document.public AcknowledgePromotionType processPromotion(ProcessPromotionType aProcessPromotion)
aProcessPromotion
- The ProcessPromotion request document.public RespondPromotionType changePromotion(ChangePromotionType aChangePromotion)
aChangePromotion
- The ChangePromotion request document.public ShowPromotionDataAreaType getPromotion(GetType getVerb) throws PromotionException
ShowPromotionDataArea
when issuing the specified
get expression to fetch Promotions. This method will be used by other frameworks or
methods that construct the get expression.getVerb
- The get expression to execute.ShowPromotionDataArea
response when issuing the get expression.PromotionException
- The PromotionException
is thrown if error
information is found in the specified ShowPromotionDataArea
.
This will represent that there was a problem when performing the operation.public java.util.List getPromotion(java.lang.String expressionLanguage, java.lang.String expression) throws PromotionException
expressionLanguage
- The expression lanaguage.expression
- The expression to return a list of Promotions.PromotionException
- The PromotionException
is thrown if error
information is found in the specified ShowPromotionDataArea
.
This will represent that there was a problem when performing the operation.public com.ibm.commerce.promotion.facade.datatypes.ShowPromoCodeType getPromoCode(com.ibm.commerce.promotion.facade.datatypes.GetPromoCodeType aGetPromoCode)
aGetPromoCode
- The GetPromoCode request document.ShowPromoCode
response document.public com.ibm.commerce.promotion.facade.datatypes.AcknowledgePromoCodeType processPromoCode(com.ibm.commerce.promotion.facade.datatypes.ProcessPromoCodeType aProcessPromoCode)
aProcessPromoCode
- The ProcessPromoCode request document.public com.ibm.commerce.promotion.facade.datatypes.RespondPromoCodeType changePromoCode(com.ibm.commerce.promotion.facade.datatypes.ChangePromoCodeType aChangePromoCode)
aChangePromoCode
- The ChangePromoCode request document.public com.ibm.commerce.promotion.facade.datatypes.ShowPromoCodeDataAreaType getPromoCode(GetType getVerb) throws com.ibm.commerce.promotion.facade.client.PromoCodeException
ShowPromoCodeDataArea
when issuing the specified
get expression to fetch PromoCodes. This method will be used by other frameworks or
methods that construct the get expression.getVerb
- The get expression to execute.ShowPromoCodeDataArea
response when issuing the get expression.PromoCodeException
- The PromoCodeException
is thrown if error
information is found in the specified ShowPromoCodeDataArea
.
This will represent that there was a problem when performing the operation.public java.util.List getPromoCode(java.lang.String expressionLanguage, java.lang.String expression) throws com.ibm.commerce.promotion.facade.client.PromoCodeException
expressionLanguage
- The expression lanaguage.expression
- The expression to return a list of PromoCodes.PromoCodeException
- The PromoCodeException
is thrown if error
information is found in the specified ShowPromoCodeDataArea
.
This will represent that there was a problem when performing the operation.