com.ibm.commerce.promotion.facade.client

Class AbstractPromotionFacadeClient

  • Direct Known Subclasses:
    PromotionFacadeClient

    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.

    • Constructor Detail

      • AbstractPromotionFacadeClient

        public AbstractPromotionFacadeClient()
        Creates an instance of the client to communicate with the Promotion facade.

      • AbstractPromotionFacadeClient

        public AbstractPromotionFacadeClient(BusinessContextType businessContext,
                                     javax.security.auth.callback.CallbackHandler callbackHandler)
        Creates an instance of the client to communicate with the Promotion 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

      • getPromotion

        public ShowPromotionType getPromotion(GetPromotionType aGetPromotion)
        This method will communicate with the Promotion facade and send the specified GetPromotion request.
        Parameters:
        aGetPromotion - The GetPromotion request document.
        Returns:
        The resulting ShowPromotion response document.

      • processPromotion

        public AcknowledgePromotionType processPromotion(ProcessPromotionType aProcessPromotion)
        This method will communicate with the Promotion facade and send the specified ProcessPromotion request.
        Parameters:
        aProcessPromotion - The ProcessPromotion request document.
        Returns:
        The resulting AcknowledgePromotion response document.

      • changePromotion

        public RespondPromotionType changePromotion(ChangePromotionType aChangePromotion)
        This method will communicate with the Promotion facade and send the specified ChangePromotion request.
        Parameters:
        aChangePromotion - The ChangePromotion request document.
        Returns:
        The resulting RespondPromotion response document.

      • getPromotion

        public ShowPromotionDataAreaType getPromotion(GetType getVerb)
                                       throws PromotionException
        This method returns the 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.
        Parameters:
        getVerb - The get expression to execute.
        Returns:
        The ShowPromotionDataArea response when issuing the get expression.
        Throws:
        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.

      • getPromotion

        public java.util.List getPromotion(java.lang.String expressionLanguage,
                                   java.lang.String expression)
                            throws PromotionException
        This method returns a list of Promotions based on the expression specified.
        Parameters:
        expressionLanguage - The expression lanaguage.
        expression - The expression to return a list of Promotions.
        Returns:
        The list of Promotions that matches the expression specified.
        Throws:
        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.

      • getPromoCode

        public 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.
        Parameters:
        aGetPromoCode - The GetPromoCode request document.
        Returns:
        The resulting ShowPromoCode response document.

      • processPromoCode

        public 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.
        Parameters:
        aProcessPromoCode - The ProcessPromoCode request document.
        Returns:
        The resulting AcknowledgePromoCode response document.

      • changePromoCode

        public 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.
        Parameters:
        aChangePromoCode - The ChangePromoCode request document.
        Returns:
        The resulting RespondPromoCode response document.

      • getPromoCode

        public com.ibm.commerce.promotion.facade.datatypes.ShowPromoCodeDataAreaType getPromoCode(GetType getVerb)
                                                                                   throws com.ibm.commerce.promotion.facade.client.PromoCodeException
        This method returns the 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.
        Parameters:
        getVerb - The get expression to execute.
        Returns:
        The ShowPromoCodeDataArea response when issuing the get expression.
        Throws:
        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.

      • getPromoCode

        public java.util.List getPromoCode(java.lang.String expressionLanguage,
                                   java.lang.String expression)
                            throws com.ibm.commerce.promotion.facade.client.PromoCodeException
        This method returns a list of PromoCodes based on the expression specified.
        Parameters:
        expressionLanguage - The expression lanaguage.
        expression - The expression to return a list of PromoCodes.
        Returns:
        The list of PromoCodes that matches the expression specified.
        Throws:
        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.
Skip navigation links