com.ibm.commerce.marketing.facade.client

Class AbstractMarketingFacadeClient

  • Direct Known Subclasses:
    MarketingFacadeClient


    public abstract class AbstractMarketingFacadeClient
    extends AbstractBusinessObjectDocumentFacadeClient

    This class provides a set of methods that can be used to communicate with the Marketing facade. This class represents a library of Marketing 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 Marketing facade.

    • Field Detail

      • COPYRIGHT

        public static final java.lang.String COPYRIGHT
        IBM Copyright notice field.
        See Also:
        Constant Field Values
    • Constructor Detail

      • AbstractMarketingFacadeClient

        public AbstractMarketingFacadeClient()
        Creates an instance of the client to communicate with the Marketing facade.
      • AbstractMarketingFacadeClient

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

      • getContentSpotData

        public com.ibm.commerce.marketing.facade.datatypes.ShowContentSpotDataType getContentSpotData(com.ibm.commerce.marketing.facade.datatypes.GetContentSpotDataType aGetContentSpotData)
        This method will communicate with the Marketing facade and send the specified GetContentSpotData request.
        Parameters:
        aGetContentSpotData - The GetContentSpotData request document.
        Returns:
        The resulting ShowContentSpotData response document.
      • getContentSpotData

        public com.ibm.commerce.marketing.facade.datatypes.ShowContentSpotDataDataAreaType getContentSpotData(GetType getVerb)
                                                                                                       throws com.ibm.commerce.marketing.facade.client.ContentSpotDataException
        This method returns the ShowContentSpotDataDataArea when issuing the specified get expression to fetch ContentSpotDatas. This method will be used by other frameworks or methods that constructs the get expression.
        Parameters:
        getVerb - The get expression to execute.
        Returns:
        The ShowContentSpotDataDataArea response when issuing the get expression.
        Throws:
        ContentSpotDataException - The ContentSpotDataException is thrown if error information is found in the specified AcknowledgeContentSpotDataDataArea. This will represent that there was a problem when performing the operation.
      • getContentSpotData

        public java.util.List getContentSpotData(java.lang.String expressionLanguage,
                                                 java.lang.String expression)
                                          throws com.ibm.commerce.marketing.facade.client.ContentSpotDataException
        This method returns a list of ContentSpotDatas based on the expression specified.
        Parameters:
        expressionLanguage - The expression language.
        expression - The expression to return a list of ContentSpotDatas.
        Returns:
        The list of ContentSpotDatas that matches the expression specified.
        Throws:
        ContentSpotDataException - The ContentSpotDataException is thrown if error information is found in the specified AcknowledgeContentSpotDataDataArea. This will represent that there was a problem when performing the operation.
      • getMarketingSpotData

        public ShowMarketingSpotDataType getMarketingSpotData(GetMarketingSpotDataType aGetMarketingSpotData)
        This method will communicate with the Marketing facade and send the specified GetMarketingSpotData request.
        Parameters:
        aGetMarketingSpotData - The GetMarketingSpotData request document.
        Returns:
        The resulting ShowMarketingSpotData response document.
      • getMarketingSpotData

        public ShowMarketingSpotDataDataAreaType getMarketingSpotData(GetType getVerb)
                                                               throws MarketingSpotDataException
        This method returns the ShowMarketingSpotDataDataArea when issuing the specified get expression to fetch MarketingSpotDatas. This method will be used by other frameworks or methods that constructs the get expression.
        Parameters:
        getVerb - The get expression to execute.
        Returns:
        The ShowMarketingSpotDataDataArea response when issuing the get expression.
        Throws:
        MarketingSpotDataException - The MarketingSpotDataException is thrown if error information is found in the specified AcknowledgeMarketingSpotDataDataArea. This will represent that there was a problem when performing the operation.
      • getMarketingSpotData

        public java.util.List getMarketingSpotData(java.lang.String expressionLanguage,
                                                   java.lang.String expression)
                                            throws MarketingSpotDataException
        This method returns a list of MarketingSpotDatas based on the expression specified.
        Parameters:
        expressionLanguage - The expression language.
        expression - The expression to return a list of MarketingSpotDatas.
        Returns:
        The list of MarketingSpotDatas that matches the expression specified.
        Throws:
        MarketingSpotDataException - The MarketingSpotDataException is thrown if error information is found in the specified AcknowledgeMarketingSpotDataDataArea. This will represent that there was a problem when performing the operation.
      • processMarketingTrigger

        public AcknowledgeMarketingTriggerType processMarketingTrigger(ProcessMarketingTriggerType aProcessMarketingTrigger)
        This method will communicate with the Marketing facade and send the specified ProcessMarketingTrigger request.
        Parameters:
        aProcessMarketingTrigger - The ProcessMarketingTrigger request document.
        Returns:
        The resulting AcknowledgeMarketingTrigger response document.
      • getMarketingTriggerFilter

        public com.ibm.commerce.marketing.facade.datatypes.ShowMarketingTriggerFilterType getMarketingTriggerFilter(com.ibm.commerce.marketing.facade.datatypes.GetMarketingTriggerFilterType aGetMarketingTriggerFilter)
        This method will communicate with the Marketing facade and send the specified GetMarketingTriggerFilter request.
        Parameters:
        aGetMarketingTriggerFilter - The GetMarketingTriggerFilter request document.
        Returns:
        The resulting ShowMarketingTriggerFilter response document.
      • getMarketingTriggerFilter

        public com.ibm.commerce.marketing.facade.datatypes.ShowMarketingTriggerFilterDataAreaType getMarketingTriggerFilter(GetType getVerb)
                                                                                                                     throws com.ibm.commerce.marketing.facade.client.MarketingTriggerFilterException
        This method returns the ShowMarketingTriggerFilterDataArea when issuing the specified get expression to fetch MarketingTriggerFilters. This method will be used by other frameworks or methods that constructs the get expression.
        Parameters:
        getVerb - The get expression to execute.
        Returns:
        The ShowMarketingTriggerFilterDataArea response when issuing the get expression.
        Throws:
        MarketingTriggerFilterException - The MarketingTriggerFilterException is thrown if error information is found in the specified AcknowledgeMarketingTriggerFilterDataArea. This will represent that there was a problem when performing the operation.
      • getMarketingTriggerFilter

        public java.util.List getMarketingTriggerFilter(java.lang.String expressionLanguage,
                                                        java.lang.String expression)
                                                 throws com.ibm.commerce.marketing.facade.client.MarketingTriggerFilterException
        This method returns a list of MarketingTriggerFilters based on the expression specified.
        Parameters:
        expressionLanguage - The expression language.
        expression - The expression to return a list of MarketingTriggerFilters.
        Returns:
        The list of MarketingTriggerFilters that matches the expression specified.
        Throws:
        MarketingTriggerFilterException - The MarketingTriggerFilterException is thrown if error information is found in the specified AcknowledgeMarketingTriggerFilterDataArea. This will represent that there was a problem when performing the operation.
      • getMarketingSpot

        public ShowMarketingSpotType getMarketingSpot(GetMarketingSpotType aGetMarketingSpot)
        This method will communicate with the Marketing facade and send the specified GetMarketingSpot request.
        Parameters:
        aGetMarketingSpot - The GetMarketingSpot request document.
        Returns:
        The resulting ShowMarketingSpot response document.
      • processMarketingSpot

        public AcknowledgeMarketingSpotType processMarketingSpot(ProcessMarketingSpotType aProcessMarketingSpot)
        This method will communicate with the Marketing facade and send the specified ProcessMarketingSpot request.
        Parameters:
        aProcessMarketingSpot - The ProcessMarketingSpot request document.
        Returns:
        The resulting AcknowledgeMarketingSpot response document.
      • changeMarketingSpot

        public RespondMarketingSpotType changeMarketingSpot(ChangeMarketingSpotType aChangeMarketingSpot)
        This method will communicate with the MarketingSpot facade and send the specified ChangeMarketingSpot request.
        Parameters:
        aChangeMarketingSpot - The ChangeMarketingSpot request document.
        Returns:
        The resulting RespondMarketingSpot response document.
      • getMarketingSpot

        public ShowMarketingSpotDataAreaType getMarketingSpot(GetType getVerb)
                                                       throws MarketingSpotException
        This method returns the ShowMarketingSpotDataArea when issuing the specified get expression to fetch MarketingSpots. This method will be used by other frameworks or methods that constructs the get expression.
        Parameters:
        getVerb - The get expression to execute.
        Returns:
        The ShowMarketingSpotDataArea response when issuing the get expression.
        Throws:
        MarketingSpotException - The MarketingSpotException is thrown if error information is found in the specified AcknowledgeMarketingSpotDataArea. This will represent that there was a problem when performing the operation.
      • getMarketingSpot

        public java.util.List getMarketingSpot(java.lang.String expressionLanguage,
                                               java.lang.String expression)
                                        throws MarketingSpotException
        This method returns a list of MarketingSpots based on the expression specified.
        Parameters:
        expressionLanguage - The expression language.
        expression - The expression to return a list of MarketingSpots.
        Returns:
        The list of MarketingSpots that matches the expression specified.
        Throws:
        MarketingSpotException - The MarketingSpotException is thrown if error information is found in the specified AcknowledgeMarketingSpotDataArea. This will represent that there was a problem when performing the operation.
      • getMarketingContent

        public ShowMarketingContentType getMarketingContent(GetMarketingContentType aGetMarketingContent)
        This method will communicate with the Marketing facade and send the specified GetMarketingContent request.
        Parameters:
        aGetMarketingContent - The GetMarketingContent request document.
        Returns:
        The resulting ShowMarketingContent response document.
      • processMarketingContent

        public AcknowledgeMarketingContentType processMarketingContent(ProcessMarketingContentType aProcessMarketingContent)
        This method will communicate with the Marketing facade and send the specified ProcessMarketingContent request.
        Parameters:
        aProcessMarketingContent - The ProcessMarketingContent request document.
        Returns:
        The resulting AcknowledgeMarketingContent response document.
      • changeMarketingContent

        public RespondMarketingContentType changeMarketingContent(ChangeMarketingContentType aChangeMarketingContent)
        This method will communicate with the MarketingContent facade and send the specified ChangeMarketingContent request.
        Parameters:
        aChangeMarketingContent - The ChangeMarketingContent request document.
        Returns:
        The resulting RespondMarketingContent response document.
      • getMarketingContent

        public ShowMarketingContentDataAreaType getMarketingContent(GetType getVerb)
                                                             throws MarketingContentException
        This method returns the ShowMarketingContentDataArea when issuing the specified get expression to fetch MarketingContents. This method will be used by other frameworks or methods that constructs the get expression.
        Parameters:
        getVerb - The get expression to execute.
        Returns:
        The ShowMarketingContentDataArea response when issuing the get expression.
        Throws:
        MarketingContentException - The MarketingContentException is thrown if error information is found in the specified AcknowledgeMarketingContentDataArea. This will represent that there was a problem when performing the operation.
      • getMarketingContent

        public java.util.List getMarketingContent(java.lang.String expressionLanguage,
                                                  java.lang.String expression)
                                           throws MarketingContentException
        This method returns a list of MarketingContents based on the expression specified.
        Parameters:
        expressionLanguage - The expression language.
        expression - The expression to return a list of MarketingContents.
        Returns:
        The list of MarketingContents that matches the expression specified.
        Throws:
        MarketingContentException - The MarketingContentException is thrown if error information is found in the specified AcknowledgeMarketingContentDataArea. This will represent that there was a problem when performing the operation.
      • getMarketingEmailTemplate

        public ShowMarketingEmailTemplateType getMarketingEmailTemplate(GetMarketingEmailTemplateType aGetMarketingEmailTemplate)
        This method will communicate with the Marketing facade and send the specified GetMarketingEmailTemplate request.
        Parameters:
        aGetMarketingEmailTemplate - The GetMarketingEmailTemplate request document.
        Returns:
        The resulting ShowMarketingEmailTemplate response document.
      • processMarketingEmailTemplate

        public AcknowledgeMarketingEmailTemplateType processMarketingEmailTemplate(ProcessMarketingEmailTemplateType aProcessMarketingEmailTemplate)
        This method will communicate with the Marketing facade and send the specified ProcessMarketingEmailTemplate request.
        Parameters:
        aProcessMarketingEmailTemplate - The ProcessMarketingEmailTemplate request document.
        Returns:
        The resulting AcknowledgeMarketingEmailTemplate response document.
      • changeMarketingEmailTemplate

        public RespondMarketingEmailTemplateType changeMarketingEmailTemplate(ChangeMarketingEmailTemplateType aChangeMarketingEmailTemplate)
        This method will communicate with the MarketingEmailTemplate facade and send the specified ChangeMarketingEmailTemplate request.
        Parameters:
        aChangeMarketingEmailTemplate - The ChangeMarketingEmailTemplate request document.
        Returns:
        The resulting RespondMarketingEmailTemplate response document.
      • getMarketingEmailTemplate

        public ShowMarketingEmailTemplateDataAreaType getMarketingEmailTemplate(GetType getVerb)
                                                                         throws MarketingEmailTemplateException
        This method returns the ShowMarketingEmailTemplateDataArea when issuing the specified get expression to fetch MarketingEmailTemplates. This method will be used by other frameworks or methods that constructs the get expression.
        Parameters:
        getVerb - The get expression to execute.
        Returns:
        The ShowMarketingEmailTemplateDataArea response when issuing the get expression.
        Throws:
        MarketingEmailTemplateException - The MarketingEmailTemplateException is thrown if error information is found in the specified AcknowledgeMarketingEmailTemplateDataArea. This will represent that there was a problem when performing the operation.
      • getMarketingEmailTemplate

        public java.util.List getMarketingEmailTemplate(java.lang.String expressionLanguage,
                                                        java.lang.String expression)
                                                 throws MarketingEmailTemplateException
        This method returns a list of MarketingEmailTemplates based on the expression specified.
        Parameters:
        expressionLanguage - The expression language.
        expression - The expression to return a list of MarketingEmailTemplates.
        Returns:
        The list of MarketingEmailTemplates that matches the expression specified.
        Throws:
        MarketingEmailTemplateException - The MarketingEmailTemplateException is thrown if error information is found in the specified AcknowledgeMarketingEmailTemplateDataArea. This will represent that there was a problem when performing the operation.
      • getCampaign

        public ShowCampaignType getCampaign(GetCampaignType aGetCampaign)
        This method will communicate with the Marketing facade and send the specified GetCampaign request.
        Parameters:
        aGetCampaign - The GetCampaign request document.
        Returns:
        The resulting ShowCampaign response document.
      • processCampaign

        public AcknowledgeCampaignType processCampaign(ProcessCampaignType aProcessCampaign)
        This method will communicate with the Marketing facade and send the specified ProcessCampaign request.
        Parameters:
        aProcessCampaign - The ProcessCampaign request document.
        Returns:
        The resulting AcknowledgeCampaign response document.
      • changeCampaign

        public RespondCampaignType changeCampaign(ChangeCampaignType aChangeCampaign)
        This method will communicate with the Campaign facade and send the specified ChangeCampaign request.
        Parameters:
        aChangeCampaign - The ChangeCampaign request document.
        Returns:
        The resulting RespondCampaign response document.
      • getCampaign

        public ShowCampaignDataAreaType getCampaign(GetType getVerb)
                                             throws CampaignException
        This method returns the ShowCampaignDataArea when issuing the specified get expression to fetch Campaigns. This method will be used by other frameworks or methods that constructs the get expression.
        Parameters:
        getVerb - The get expression to execute.
        Returns:
        The ShowCampaignDataArea response when issuing the get expression.
        Throws:
        CampaignException - The CampaignException is thrown if error information is found in the specified AcknowledgeCampaignDataArea. This will represent that there was a problem when performing the operation.
      • getCampaign

        public java.util.List getCampaign(java.lang.String expressionLanguage,
                                          java.lang.String expression)
                                   throws CampaignException
        This method returns a list of Campaigns based on the expression specified.
        Parameters:
        expressionLanguage - The expression language.
        expression - The expression to return a list of Campaigns.
        Returns:
        The list of Campaigns that matches the expression specified.
        Throws:
        CampaignException - The CampaignException is thrown if error information is found in the specified AcknowledgeCampaignDataArea. This will represent that there was a problem when performing the operation.
      • getActivity

        public ShowActivityType getActivity(GetActivityType aGetActivity)
        This method will communicate with the Marketing facade and send the specified GetActivity request.
        Parameters:
        aGetActivity - The GetActivity request document.
        Returns:
        The resulting ShowActivity response document.
      • processActivity

        public AcknowledgeActivityType processActivity(ProcessActivityType aProcessActivity)
        This method will communicate with the Marketing facade and send the specified ProcessActivity request.
        Parameters:
        aProcessActivity - The ProcessActivity request document.
        Returns:
        The resulting AcknowledgeActivity response document.
      • changeActivity

        public RespondActivityType changeActivity(ChangeActivityType aChangeActivity)
        This method will communicate with the Activity facade and send the specified ChangeActivity request.
        Parameters:
        aChangeActivity - The ChangeActivity request document.
        Returns:
        The resulting RespondActivity response document.
      • getActivity

        public ShowActivityDataAreaType getActivity(GetType getVerb)
                                             throws ActivityException
        This method returns the ShowActivityDataArea when issuing the specified get expression to fetch Activitys. This method will be used by other frameworks or methods that constructs the get expression.
        Parameters:
        getVerb - The get expression to execute.
        Returns:
        The ShowActivityDataArea response when issuing the get expression.
        Throws:
        ActivityException - The ActivityException is thrown if error information is found in the specified AcknowledgeActivityDataArea. This will represent that there was a problem when performing the operation.
      • getActivity

        public java.util.List getActivity(java.lang.String expressionLanguage,
                                          java.lang.String expression)
                                   throws ActivityException
        This method returns a list of Activitys based on the expression specified.
        Parameters:
        expressionLanguage - The expression language.
        expression - The expression to return a list of Activitys.
        Returns:
        The list of Activitys that matches the expression specified.
        Throws:
        ActivityException - The ActivityException is thrown if error information is found in the specified AcknowledgeActivityDataArea. This will represent that there was a problem when performing the operation.
      • getCampaignElementTemplate

        public ShowCampaignElementTemplateType getCampaignElementTemplate(GetCampaignElementTemplateType aGetCampaignElementTemplate)
        This method will communicate with the Marketing facade and send the specified GetCampaignElementTemplate request.
        Parameters:
        aGetCampaignElementTemplate - The GetCampaignElementTemplate request document.
        Returns:
        The resulting ShowCampaignElementTemplate response document.
      • processCampaignElementTemplate

        public AcknowledgeCampaignElementTemplateType processCampaignElementTemplate(ProcessCampaignElementTemplateType aProcessCampaignElementTemplate)
        This method will communicate with the Marketing facade and send the specified ProcessCampaignElementTemplate request.
        Parameters:
        aProcessCampaignElementTemplate - The ProcessCampaignElementTemplate request document.
        Returns:
        The resulting AcknowledgeCampaignElementTemplate response document.
      • changeCampaignElementTemplate

        public RespondCampaignElementTemplateType changeCampaignElementTemplate(ChangeCampaignElementTemplateType aChangeCampaignElementTemplate)
        This method will communicate with the CampaignElementTemplate facade and send the specified ChangeCampaignElementTemplate request.
        Parameters:
        aChangeCampaignElementTemplate - The ChangeCampaignElementTemplate request document.
        Returns:
        The resulting RespondCampaignElementTemplate response document.
      • getCampaignElementTemplate

        public ShowCampaignElementTemplateDataAreaType getCampaignElementTemplate(GetType getVerb)
                                                                           throws CampaignElementTemplateException
        This method returns the ShowCampaignElementTemplateDataArea when issuing the specified get expression to fetch CampaignElementTemplates. This method will be used by other frameworks or methods that constructs the get expression.
        Parameters:
        getVerb - The get expression to execute.
        Returns:
        The ShowCampaignElementTemplateDataArea response when issuing the get expression.
        Throws:
        CampaignElementTemplateException - The CampaignElementTemplateException is thrown if error information is found in the specified AcknowledgeCampaignElementTemplateDataArea. This will represent that there was a problem when performing the operation.
      • getCampaignElementTemplate

        public java.util.List getCampaignElementTemplate(java.lang.String expressionLanguage,
                                                         java.lang.String expression)
                                                  throws CampaignElementTemplateException
        This method returns a list of CampaignElementTemplates based on the expression specified.
        Parameters:
        expressionLanguage - The expression language.
        expression - The expression to return a list of CampaignElementTemplates.
        Returns:
        The list of CampaignElementTemplates that matches the expression specified.
        Throws:
        CampaignElementTemplateException - The CampaignElementTemplateException is thrown if error information is found in the specified AcknowledgeCampaignElementTemplateDataArea. This will represent that there was a problem when performing the operation.