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.
Modifier and Type | Field and Description |
---|---|
static java.lang.String | COPYRIGHT
IBM Copyright notice field.
|
Constructor and Description |
---|
AbstractMarketingFacadeClient()
Creates an instance of the client to communicate with the Marketing facade.
|
AbstractMarketingFacadeClient(BusinessContextType businessContext, javax.security.auth.callback.CallbackHandler callbackHandler)
Creates an instance of the client to communicate with the Marketing facade.
|
Modifier and Type | Method and Description |
---|---|
RespondActivityType | changeActivity(ChangeActivityType aChangeActivity)
This method will communicate with the Activity facade and send the specified ChangeActivity request.
|
RespondCampaignType | changeCampaign(ChangeCampaignType aChangeCampaign)
This method will communicate with the Campaign facade and send the specified ChangeCampaign request.
|
RespondCampaignElementTemplateType | changeCampaignElementTemplate(ChangeCampaignElementTemplateType aChangeCampaignElementTemplate)
This method will communicate with the CampaignElementTemplate facade and send the specified ChangeCampaignElementTemplate request.
|
RespondMarketingContentType | changeMarketingContent(ChangeMarketingContentType aChangeMarketingContent)
This method will communicate with the MarketingContent facade and send the specified ChangeMarketingContent request.
|
RespondMarketingEmailTemplateType | changeMarketingEmailTemplate(ChangeMarketingEmailTemplateType aChangeMarketingEmailTemplate)
This method will communicate with the MarketingEmailTemplate facade and send the specified ChangeMarketingEmailTemplate request.
|
RespondMarketingSpotType | changeMarketingSpot(ChangeMarketingSpotType aChangeMarketingSpot)
This method will communicate with the MarketingSpot facade and send the specified ChangeMarketingSpot request.
|
protected AcknowledgeActivityDataAreaType | checkAcknowledgeActivity(AcknowledgeActivityDataAreaType acknowledgeActivityDataArea)
This method will examine the AcknowledgeActivityDataArea to see if there is any error information reported.
|
protected AcknowledgeCampaignDataAreaType | checkAcknowledgeCampaign(AcknowledgeCampaignDataAreaType acknowledgeCampaignDataArea)
This method will examine the AcknowledgeCampaignDataArea to see if there is any error information reported.
|
protected AcknowledgeCampaignElementTemplateDataAreaType | checkAcknowledgeCampaignElementTemplate(AcknowledgeCampaignElementTemplateDataAreaType acknowledgeCampaignElementTemplateDataArea)
This method will examine the AcknowledgeCampaignElementTemplateDataArea to see if there is any error information reported.
|
protected AcknowledgeMarketingContentDataAreaType | checkAcknowledgeMarketingContent(AcknowledgeMarketingContentDataAreaType acknowledgeMarketingContentDataArea)
This method will examine the AcknowledgeMarketingContentDataArea to see if there is any error information reported.
|
protected AcknowledgeMarketingEmailTemplateDataAreaType | checkAcknowledgeMarketingEmailTemplate(AcknowledgeMarketingEmailTemplateDataAreaType acknowledgeMarketingEmailTemplateDataArea)
This method will examine the AcknowledgeMarketingEmailTemplateDataArea to see if there is any error information reported.
|
protected AcknowledgeMarketingSpotDataAreaType | checkAcknowledgeMarketingSpot(AcknowledgeMarketingSpotDataAreaType acknowledgeMarketingSpotDataArea)
This method will examine the AcknowledgeMarketingSpotDataArea to see if there is any error information reported.
|
protected AcknowledgeMarketingTriggerDataAreaType | checkAcknowledgeMarketingTrigger(AcknowledgeMarketingTriggerDataAreaType acknowledgeMarketingTriggerDataArea)
This method will examine the AcknowledgeMarketingTriggerDataArea to see if there is any error information reported.
|
protected RespondActivityDataAreaType | checkRespondActivity(RespondActivityDataAreaType respondActivityDataArea)
This method will examine the RespondActivityDataArea to see if there is any error information reported.
|
protected RespondCampaignDataAreaType | checkRespondCampaign(RespondCampaignDataAreaType respondCampaignDataArea)
This method will examine the RespondCampaignDataArea to see if there is any error information reported.
|
protected RespondCampaignElementTemplateDataAreaType | checkRespondCampaignElementTemplate(RespondCampaignElementTemplateDataAreaType respondCampaignElementTemplateDataArea)
This method will examine the RespondCampaignElementTemplateDataArea to see if there is any error information reported.
|
protected RespondMarketingContentDataAreaType | checkRespondMarketingContent(RespondMarketingContentDataAreaType respondMarketingContentDataArea)
This method will examine the RespondMarketingContentDataArea to see if there is any error information reported.
|
protected RespondMarketingEmailTemplateDataAreaType | checkRespondMarketingEmailTemplate(RespondMarketingEmailTemplateDataAreaType respondMarketingEmailTemplateDataArea)
This method will examine the RespondMarketingEmailTemplateDataArea to see if there is any error information reported.
|
protected RespondMarketingSpotDataAreaType | checkRespondMarketingSpot(RespondMarketingSpotDataAreaType respondMarketingSpotDataArea)
This method will examine the RespondMarketingSpotDataArea to see if there is any error information reported.
|
protected ShowActivityDataAreaType | checkShowActivity(ShowActivityDataAreaType showActivityDataArea)
This method will examine the ShowActivityDataArea to see if there is any error information reported.
|
protected ShowCampaignDataAreaType | checkShowCampaign(ShowCampaignDataAreaType showCampaignDataArea)
This method will examine the ShowCampaignDataArea to see if there is any error information reported.
|
protected ShowCampaignElementTemplateDataAreaType | checkShowCampaignElementTemplate(ShowCampaignElementTemplateDataAreaType showCampaignElementTemplateDataArea)
This method will examine the ShowCampaignElementTemplateDataArea to see if there is any error information reported.
|
protected com.ibm.commerce.marketing.facade.datatypes.ShowContentSpotDataDataAreaType | checkShowContentSpotData(com.ibm.commerce.marketing.facade.datatypes.ShowContentSpotDataDataAreaType showContentSpotDataDataArea)
This method will examine the ShowContentSpotDataDataArea to see if there is any error information reported.
|
protected ShowMarketingContentDataAreaType | checkShowMarketingContent(ShowMarketingContentDataAreaType showMarketingContentDataArea)
This method will examine the ShowMarketingContentDataArea to see if there is any error information reported.
|
protected ShowMarketingEmailTemplateDataAreaType | checkShowMarketingEmailTemplate(ShowMarketingEmailTemplateDataAreaType showMarketingEmailTemplateDataArea)
This method will examine the ShowMarketingEmailTemplateDataArea to see if there is any error information reported.
|
protected ShowMarketingSpotDataAreaType | checkShowMarketingSpot(ShowMarketingSpotDataAreaType showMarketingSpotDataArea)
This method will examine the ShowMarketingSpotDataArea to see if there is any error information reported.
|
protected ShowMarketingSpotDataDataAreaType | checkShowMarketingSpotData(ShowMarketingSpotDataDataAreaType showMarketingSpotDataDataArea)
This method will examine the ShowMarketingSpotDataDataArea to see if there is any error information reported.
|
protected com.ibm.commerce.marketing.facade.datatypes.ShowMarketingTriggerFilterDataAreaType | checkShowMarketingTriggerFilter(com.ibm.commerce.marketing.facade.datatypes.ShowMarketingTriggerFilterDataAreaType showMarketingTriggerFilterDataArea)
This method will examine the ShowMarketingTriggerFilterDataArea to see if there is any error information reported.
|
ShowActivityType | getActivity(GetActivityType aGetActivity)
This method will communicate with the Marketing facade and send the specified GetActivity request.
|
ShowActivityDataAreaType | getActivity(GetType getVerb)
This method returns the ShowActivityDataArea when issuing the specified get expression to fetch Activitys.
|
java.util.List | getActivity(java.lang.String expressionLanguage, java.lang.String expression)
This method returns a list of Activitys based on the expression specified.
|
ShowCampaignType | getCampaign(GetCampaignType aGetCampaign)
This method will communicate with the Marketing facade and send the specified GetCampaign request.
|
ShowCampaignDataAreaType | getCampaign(GetType getVerb)
This method returns the ShowCampaignDataArea when issuing the specified get expression to fetch Campaigns.
|
java.util.List | getCampaign(java.lang.String expressionLanguage, java.lang.String expression)
This method returns a list of Campaigns based on the expression specified.
|
ShowCampaignElementTemplateType | getCampaignElementTemplate(GetCampaignElementTemplateType aGetCampaignElementTemplate)
This method will communicate with the Marketing facade and send the specified GetCampaignElementTemplate request.
|
ShowCampaignElementTemplateDataAreaType | getCampaignElementTemplate(GetType getVerb)
This method returns the ShowCampaignElementTemplateDataArea when issuing the specified get expression to fetch CampaignElementTemplates.
|
java.util.List | getCampaignElementTemplate(java.lang.String expressionLanguage, java.lang.String expression)
This method returns a list of CampaignElementTemplates based on the expression specified.
|
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.
|
com.ibm.commerce.marketing.facade.datatypes.ShowContentSpotDataDataAreaType | getContentSpotData(GetType getVerb)
This method returns the ShowContentSpotDataDataArea when issuing the specified get expression to fetch ContentSpotDatas.
|
java.util.List | getContentSpotData(java.lang.String expressionLanguage, java.lang.String expression)
This method returns a list of ContentSpotDatas based on the expression specified.
|
ShowMarketingContentType | getMarketingContent(GetMarketingContentType aGetMarketingContent)
This method will communicate with the Marketing facade and send the specified GetMarketingContent request.
|
ShowMarketingContentDataAreaType | getMarketingContent(GetType getVerb)
This method returns the ShowMarketingContentDataArea when issuing the specified get expression to fetch MarketingContents.
|
java.util.List | getMarketingContent(java.lang.String expressionLanguage, java.lang.String expression)
This method returns a list of MarketingContents based on the expression specified.
|
ShowMarketingEmailTemplateType | getMarketingEmailTemplate(GetMarketingEmailTemplateType aGetMarketingEmailTemplate)
This method will communicate with the Marketing facade and send the specified GetMarketingEmailTemplate request.
|
ShowMarketingEmailTemplateDataAreaType | getMarketingEmailTemplate(GetType getVerb)
This method returns the ShowMarketingEmailTemplateDataArea when issuing the specified get expression to fetch MarketingEmailTemplates.
|
java.util.List | getMarketingEmailTemplate(java.lang.String expressionLanguage, java.lang.String expression)
This method returns a list of MarketingEmailTemplates based on the expression specified.
|
protected MarketingFactory | getMarketingFactory()
This method will return the default instance of the Marketing Factory.
|
ShowMarketingSpotType | getMarketingSpot(GetMarketingSpotType aGetMarketingSpot)
This method will communicate with the Marketing facade and send the specified GetMarketingSpot request.
|
ShowMarketingSpotDataAreaType | getMarketingSpot(GetType getVerb)
This method returns the ShowMarketingSpotDataArea when issuing the specified get expression to fetch MarketingSpots.
|
java.util.List | getMarketingSpot(java.lang.String expressionLanguage, java.lang.String expression)
This method returns a list of MarketingSpots based on the expression specified.
|
ShowMarketingSpotDataType | getMarketingSpotData(GetMarketingSpotDataType aGetMarketingSpotData)
This method will communicate with the Marketing facade and send the specified GetMarketingSpotData request.
|
ShowMarketingSpotDataDataAreaType | getMarketingSpotData(GetType getVerb)
This method returns the ShowMarketingSpotDataDataArea when issuing the specified get expression to fetch MarketingSpotDatas.
|
java.util.List | getMarketingSpotData(java.lang.String expressionLanguage, java.lang.String expression)
This method returns a list of MarketingSpotDatas based on the expression specified.
|
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.
|
com.ibm.commerce.marketing.facade.datatypes.ShowMarketingTriggerFilterDataAreaType | getMarketingTriggerFilter(GetType getVerb)
This method returns the ShowMarketingTriggerFilterDataArea when issuing the specified get expression to fetch MarketingTriggerFilters.
|
java.util.List | getMarketingTriggerFilter(java.lang.String expressionLanguage, java.lang.String expression)
This method returns a list of MarketingTriggerFilters based on the expression specified.
|
AcknowledgeActivityType | processActivity(ProcessActivityType aProcessActivity)
This method will communicate with the Marketing facade and send the specified ProcessActivity request.
|
AcknowledgeCampaignType | processCampaign(ProcessCampaignType aProcessCampaign)
This method will communicate with the Marketing facade and send the specified ProcessCampaign request.
|
AcknowledgeCampaignElementTemplateType | processCampaignElementTemplate(ProcessCampaignElementTemplateType aProcessCampaignElementTemplate)
This method will communicate with the Marketing facade and send the specified ProcessCampaignElementTemplate request.
|
AcknowledgeMarketingContentType | processMarketingContent(ProcessMarketingContentType aProcessMarketingContent)
This method will communicate with the Marketing facade and send the specified ProcessMarketingContent request.
|
AcknowledgeMarketingEmailTemplateType | processMarketingEmailTemplate(ProcessMarketingEmailTemplateType aProcessMarketingEmailTemplate)
This method will communicate with the Marketing facade and send the specified ProcessMarketingEmailTemplate request.
|
AcknowledgeMarketingSpotType | processMarketingSpot(ProcessMarketingSpotType aProcessMarketingSpot)
This method will communicate with the Marketing facade and send the specified ProcessMarketingSpot request.
|
AcknowledgeMarketingTriggerType | processMarketingTrigger(ProcessMarketingTriggerType aProcessMarketingTrigger)
This method will communicate with the Marketing facade and send the specified ProcessMarketingTrigger request.
|
public static final java.lang.String COPYRIGHT
public AbstractMarketingFacadeClient()
public AbstractMarketingFacadeClient(BusinessContextType businessContext, javax.security.auth.callback.CallbackHandler callbackHandler)
protected MarketingFactory getMarketingFactory()
public com.ibm.commerce.marketing.facade.datatypes.ShowContentSpotDataType getContentSpotData(com.ibm.commerce.marketing.facade.datatypes.GetContentSpotDataType aGetContentSpotData)
protected com.ibm.commerce.marketing.facade.datatypes.ShowContentSpotDataDataAreaType checkShowContentSpotData(com.ibm.commerce.marketing.facade.datatypes.ShowContentSpotDataDataAreaType showContentSpotDataDataArea) throws com.ibm.commerce.marketing.facade.client.ContentSpotDataException
public com.ibm.commerce.marketing.facade.datatypes.ShowContentSpotDataDataAreaType getContentSpotData(GetType getVerb) throws com.ibm.commerce.marketing.facade.client.ContentSpotDataException
public java.util.List getContentSpotData(java.lang.String expressionLanguage, java.lang.String expression) throws com.ibm.commerce.marketing.facade.client.ContentSpotDataException
public ShowMarketingSpotDataType getMarketingSpotData(GetMarketingSpotDataType aGetMarketingSpotData)
protected ShowMarketingSpotDataDataAreaType checkShowMarketingSpotData(ShowMarketingSpotDataDataAreaType showMarketingSpotDataDataArea) throws MarketingSpotDataException
public ShowMarketingSpotDataDataAreaType getMarketingSpotData(GetType getVerb) throws MarketingSpotDataException
public java.util.List getMarketingSpotData(java.lang.String expressionLanguage, java.lang.String expression) throws MarketingSpotDataException
public AcknowledgeMarketingTriggerType processMarketingTrigger(ProcessMarketingTriggerType aProcessMarketingTrigger)
protected AcknowledgeMarketingTriggerDataAreaType checkAcknowledgeMarketingTrigger(AcknowledgeMarketingTriggerDataAreaType acknowledgeMarketingTriggerDataArea) throws MarketingTriggerException
public com.ibm.commerce.marketing.facade.datatypes.ShowMarketingTriggerFilterType getMarketingTriggerFilter(com.ibm.commerce.marketing.facade.datatypes.GetMarketingTriggerFilterType aGetMarketingTriggerFilter)
protected com.ibm.commerce.marketing.facade.datatypes.ShowMarketingTriggerFilterDataAreaType checkShowMarketingTriggerFilter(com.ibm.commerce.marketing.facade.datatypes.ShowMarketingTriggerFilterDataAreaType showMarketingTriggerFilterDataArea) throws com.ibm.commerce.marketing.facade.client.MarketingTriggerFilterException
public com.ibm.commerce.marketing.facade.datatypes.ShowMarketingTriggerFilterDataAreaType getMarketingTriggerFilter(GetType getVerb) throws com.ibm.commerce.marketing.facade.client.MarketingTriggerFilterException
public java.util.List getMarketingTriggerFilter(java.lang.String expressionLanguage, java.lang.String expression) throws com.ibm.commerce.marketing.facade.client.MarketingTriggerFilterException
public ShowMarketingSpotType getMarketingSpot(GetMarketingSpotType aGetMarketingSpot)
public AcknowledgeMarketingSpotType processMarketingSpot(ProcessMarketingSpotType aProcessMarketingSpot)
public RespondMarketingSpotType changeMarketingSpot(ChangeMarketingSpotType aChangeMarketingSpot)
protected AcknowledgeMarketingSpotDataAreaType checkAcknowledgeMarketingSpot(AcknowledgeMarketingSpotDataAreaType acknowledgeMarketingSpotDataArea) throws MarketingSpotException
protected RespondMarketingSpotDataAreaType checkRespondMarketingSpot(RespondMarketingSpotDataAreaType respondMarketingSpotDataArea) throws MarketingSpotException
protected ShowMarketingSpotDataAreaType checkShowMarketingSpot(ShowMarketingSpotDataAreaType showMarketingSpotDataArea) throws MarketingSpotException
public ShowMarketingSpotDataAreaType getMarketingSpot(GetType getVerb) throws MarketingSpotException
public java.util.List getMarketingSpot(java.lang.String expressionLanguage, java.lang.String expression) throws MarketingSpotException
public ShowMarketingContentType getMarketingContent(GetMarketingContentType aGetMarketingContent)
public AcknowledgeMarketingContentType processMarketingContent(ProcessMarketingContentType aProcessMarketingContent)
public RespondMarketingContentType changeMarketingContent(ChangeMarketingContentType aChangeMarketingContent)
protected AcknowledgeMarketingContentDataAreaType checkAcknowledgeMarketingContent(AcknowledgeMarketingContentDataAreaType acknowledgeMarketingContentDataArea) throws MarketingContentException
protected RespondMarketingContentDataAreaType checkRespondMarketingContent(RespondMarketingContentDataAreaType respondMarketingContentDataArea) throws MarketingContentException
protected ShowMarketingContentDataAreaType checkShowMarketingContent(ShowMarketingContentDataAreaType showMarketingContentDataArea) throws MarketingContentException
public ShowMarketingContentDataAreaType getMarketingContent(GetType getVerb) throws MarketingContentException
public java.util.List getMarketingContent(java.lang.String expressionLanguage, java.lang.String expression) throws MarketingContentException
public ShowMarketingEmailTemplateType getMarketingEmailTemplate(GetMarketingEmailTemplateType aGetMarketingEmailTemplate)
public AcknowledgeMarketingEmailTemplateType processMarketingEmailTemplate(ProcessMarketingEmailTemplateType aProcessMarketingEmailTemplate)
public RespondMarketingEmailTemplateType changeMarketingEmailTemplate(ChangeMarketingEmailTemplateType aChangeMarketingEmailTemplate)
protected AcknowledgeMarketingEmailTemplateDataAreaType checkAcknowledgeMarketingEmailTemplate(AcknowledgeMarketingEmailTemplateDataAreaType acknowledgeMarketingEmailTemplateDataArea) throws MarketingEmailTemplateException
protected RespondMarketingEmailTemplateDataAreaType checkRespondMarketingEmailTemplate(RespondMarketingEmailTemplateDataAreaType respondMarketingEmailTemplateDataArea) throws MarketingEmailTemplateException
protected ShowMarketingEmailTemplateDataAreaType checkShowMarketingEmailTemplate(ShowMarketingEmailTemplateDataAreaType showMarketingEmailTemplateDataArea) throws MarketingEmailTemplateException
public ShowMarketingEmailTemplateDataAreaType getMarketingEmailTemplate(GetType getVerb) throws MarketingEmailTemplateException
public java.util.List getMarketingEmailTemplate(java.lang.String expressionLanguage, java.lang.String expression) throws MarketingEmailTemplateException
public ShowCampaignType getCampaign(GetCampaignType aGetCampaign)
public AcknowledgeCampaignType processCampaign(ProcessCampaignType aProcessCampaign)
public RespondCampaignType changeCampaign(ChangeCampaignType aChangeCampaign)
protected AcknowledgeCampaignDataAreaType checkAcknowledgeCampaign(AcknowledgeCampaignDataAreaType acknowledgeCampaignDataArea) throws CampaignException
protected RespondCampaignDataAreaType checkRespondCampaign(RespondCampaignDataAreaType respondCampaignDataArea) throws CampaignException
protected ShowCampaignDataAreaType checkShowCampaign(ShowCampaignDataAreaType showCampaignDataArea) throws CampaignException
public ShowCampaignDataAreaType getCampaign(GetType getVerb) throws CampaignException
public java.util.List getCampaign(java.lang.String expressionLanguage, java.lang.String expression) throws CampaignException
public ShowActivityType getActivity(GetActivityType aGetActivity)
public AcknowledgeActivityType processActivity(ProcessActivityType aProcessActivity)
public RespondActivityType changeActivity(ChangeActivityType aChangeActivity)
protected AcknowledgeActivityDataAreaType checkAcknowledgeActivity(AcknowledgeActivityDataAreaType acknowledgeActivityDataArea) throws ActivityException
protected RespondActivityDataAreaType checkRespondActivity(RespondActivityDataAreaType respondActivityDataArea) throws ActivityException
protected ShowActivityDataAreaType checkShowActivity(ShowActivityDataAreaType showActivityDataArea) throws ActivityException
public ShowActivityDataAreaType getActivity(GetType getVerb) throws ActivityException
public java.util.List getActivity(java.lang.String expressionLanguage, java.lang.String expression) throws ActivityException
public ShowCampaignElementTemplateType getCampaignElementTemplate(GetCampaignElementTemplateType aGetCampaignElementTemplate)
public AcknowledgeCampaignElementTemplateType processCampaignElementTemplate(ProcessCampaignElementTemplateType aProcessCampaignElementTemplate)
public RespondCampaignElementTemplateType changeCampaignElementTemplate(ChangeCampaignElementTemplateType aChangeCampaignElementTemplate)
protected AcknowledgeCampaignElementTemplateDataAreaType checkAcknowledgeCampaignElementTemplate(AcknowledgeCampaignElementTemplateDataAreaType acknowledgeCampaignElementTemplateDataArea) throws CampaignElementTemplateException
protected RespondCampaignElementTemplateDataAreaType checkRespondCampaignElementTemplate(RespondCampaignElementTemplateDataAreaType respondCampaignElementTemplateDataArea) throws CampaignElementTemplateException
protected ShowCampaignElementTemplateDataAreaType checkShowCampaignElementTemplate(ShowCampaignElementTemplateDataAreaType showCampaignElementTemplateDataArea) throws CampaignElementTemplateException
public ShowCampaignElementTemplateDataAreaType getCampaignElementTemplate(GetType getVerb) throws CampaignElementTemplateException
public java.util.List getCampaignElementTemplate(java.lang.String expressionLanguage, java.lang.String expression) throws CampaignElementTemplateException