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.
|
CHANGE_VERB_ACTION_ADD, CHANGE_VERB_ACTION_CHANGE, CHANGE_VERB_ACTION_CREATE, CHANGE_VERB_ACTION_DELETE, CHANGE_VERB_ACTION_UPDATE
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.
|
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.
|
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.
|
createActionExpression, createChangeVerb, createGetVerb, createGetVerb, createProcessVerb, createSyncVerb
public static final java.lang.String COPYRIGHT
public AbstractMarketingFacadeClient()
public AbstractMarketingFacadeClient(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 com.ibm.commerce.marketing.facade.datatypes.ShowContentSpotDataType getContentSpotData(com.ibm.commerce.marketing.facade.datatypes.GetContentSpotDataType aGetContentSpotData)
aGetContentSpotData
- The GetContentSpotData request document.ShowContentSpotData
response document.public com.ibm.commerce.marketing.facade.datatypes.ShowContentSpotDataDataAreaType getContentSpotData(GetType getVerb) throws com.ibm.commerce.marketing.facade.client.ContentSpotDataException
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.getVerb
- The get expression to execute.ShowContentSpotDataDataArea
response when issuing the get expression.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.public java.util.List getContentSpotData(java.lang.String expressionLanguage, java.lang.String expression) throws com.ibm.commerce.marketing.facade.client.ContentSpotDataException
expressionLanguage
- The expression language.expression
- The expression to return a list of ContentSpotDatas.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.public ShowMarketingSpotDataType getMarketingSpotData(GetMarketingSpotDataType aGetMarketingSpotData)
aGetMarketingSpotData
- The GetMarketingSpotData request document.ShowMarketingSpotData
response document.public ShowMarketingSpotDataDataAreaType getMarketingSpotData(GetType getVerb) throws MarketingSpotDataException
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.getVerb
- The get expression to execute.ShowMarketingSpotDataDataArea
response when issuing the get expression.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.public java.util.List getMarketingSpotData(java.lang.String expressionLanguage, java.lang.String expression) throws MarketingSpotDataException
expressionLanguage
- The expression language.expression
- The expression to return a list of MarketingSpotDatas.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.public AcknowledgeMarketingTriggerType processMarketingTrigger(ProcessMarketingTriggerType aProcessMarketingTrigger)
aProcessMarketingTrigger
- The ProcessMarketingTrigger request document.public com.ibm.commerce.marketing.facade.datatypes.ShowMarketingTriggerFilterType getMarketingTriggerFilter(com.ibm.commerce.marketing.facade.datatypes.GetMarketingTriggerFilterType aGetMarketingTriggerFilter)
aGetMarketingTriggerFilter
- The GetMarketingTriggerFilter request document.ShowMarketingTriggerFilter
response document.public com.ibm.commerce.marketing.facade.datatypes.ShowMarketingTriggerFilterDataAreaType getMarketingTriggerFilter(GetType getVerb) throws com.ibm.commerce.marketing.facade.client.MarketingTriggerFilterException
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.getVerb
- The get expression to execute.ShowMarketingTriggerFilterDataArea
response when issuing the get expression.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.public java.util.List getMarketingTriggerFilter(java.lang.String expressionLanguage, java.lang.String expression) throws com.ibm.commerce.marketing.facade.client.MarketingTriggerFilterException
expressionLanguage
- The expression language.expression
- The expression to return a list of MarketingTriggerFilters.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.public ShowMarketingSpotType getMarketingSpot(GetMarketingSpotType aGetMarketingSpot)
aGetMarketingSpot
- The GetMarketingSpot request document.ShowMarketingSpot
response document.public AcknowledgeMarketingSpotType processMarketingSpot(ProcessMarketingSpotType aProcessMarketingSpot)
aProcessMarketingSpot
- The ProcessMarketingSpot request document.public RespondMarketingSpotType changeMarketingSpot(ChangeMarketingSpotType aChangeMarketingSpot)
aChangeMarketingSpot
- The ChangeMarketingSpot request document.public ShowMarketingSpotDataAreaType getMarketingSpot(GetType getVerb) throws MarketingSpotException
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.getVerb
- The get expression to execute.ShowMarketingSpotDataArea
response when issuing the get expression.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.public java.util.List getMarketingSpot(java.lang.String expressionLanguage, java.lang.String expression) throws MarketingSpotException
expressionLanguage
- The expression language.expression
- The expression to return a list of MarketingSpots.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.public ShowMarketingContentType getMarketingContent(GetMarketingContentType aGetMarketingContent)
aGetMarketingContent
- The GetMarketingContent request document.ShowMarketingContent
response document.public AcknowledgeMarketingContentType processMarketingContent(ProcessMarketingContentType aProcessMarketingContent)
aProcessMarketingContent
- The ProcessMarketingContent request document.public RespondMarketingContentType changeMarketingContent(ChangeMarketingContentType aChangeMarketingContent)
aChangeMarketingContent
- The ChangeMarketingContent request document.public ShowMarketingContentDataAreaType getMarketingContent(GetType getVerb) throws MarketingContentException
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.getVerb
- The get expression to execute.ShowMarketingContentDataArea
response when issuing the get expression.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.public java.util.List getMarketingContent(java.lang.String expressionLanguage, java.lang.String expression) throws MarketingContentException
expressionLanguage
- The expression language.expression
- The expression to return a list of MarketingContents.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.public ShowMarketingEmailTemplateType getMarketingEmailTemplate(GetMarketingEmailTemplateType aGetMarketingEmailTemplate)
aGetMarketingEmailTemplate
- The GetMarketingEmailTemplate request document.ShowMarketingEmailTemplate
response document.public AcknowledgeMarketingEmailTemplateType processMarketingEmailTemplate(ProcessMarketingEmailTemplateType aProcessMarketingEmailTemplate)
aProcessMarketingEmailTemplate
- The ProcessMarketingEmailTemplate request document.public RespondMarketingEmailTemplateType changeMarketingEmailTemplate(ChangeMarketingEmailTemplateType aChangeMarketingEmailTemplate)
aChangeMarketingEmailTemplate
- The ChangeMarketingEmailTemplate request document.public ShowMarketingEmailTemplateDataAreaType getMarketingEmailTemplate(GetType getVerb) throws MarketingEmailTemplateException
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.getVerb
- The get expression to execute.ShowMarketingEmailTemplateDataArea
response when issuing the get expression.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.public java.util.List getMarketingEmailTemplate(java.lang.String expressionLanguage, java.lang.String expression) throws MarketingEmailTemplateException
expressionLanguage
- The expression language.expression
- The expression to return a list of MarketingEmailTemplates.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.public ShowCampaignType getCampaign(GetCampaignType aGetCampaign)
aGetCampaign
- The GetCampaign request document.ShowCampaign
response document.public AcknowledgeCampaignType processCampaign(ProcessCampaignType aProcessCampaign)
aProcessCampaign
- The ProcessCampaign request document.public RespondCampaignType changeCampaign(ChangeCampaignType aChangeCampaign)
aChangeCampaign
- The ChangeCampaign request document.public ShowCampaignDataAreaType getCampaign(GetType getVerb) throws CampaignException
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.getVerb
- The get expression to execute.ShowCampaignDataArea
response when issuing the get expression.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.public java.util.List getCampaign(java.lang.String expressionLanguage, java.lang.String expression) throws CampaignException
expressionLanguage
- The expression language.expression
- The expression to return a list of Campaigns.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.public ShowActivityType getActivity(GetActivityType aGetActivity)
aGetActivity
- The GetActivity request document.ShowActivity
response document.public AcknowledgeActivityType processActivity(ProcessActivityType aProcessActivity)
aProcessActivity
- The ProcessActivity request document.public RespondActivityType changeActivity(ChangeActivityType aChangeActivity)
aChangeActivity
- The ChangeActivity request document.public ShowActivityDataAreaType getActivity(GetType getVerb) throws ActivityException
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.getVerb
- The get expression to execute.ShowActivityDataArea
response when issuing the get expression.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.public java.util.List getActivity(java.lang.String expressionLanguage, java.lang.String expression) throws ActivityException
expressionLanguage
- The expression language.expression
- The expression to return a list of Activitys.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.public ShowCampaignElementTemplateType getCampaignElementTemplate(GetCampaignElementTemplateType aGetCampaignElementTemplate)
aGetCampaignElementTemplate
- The GetCampaignElementTemplate request document.ShowCampaignElementTemplate
response document.public AcknowledgeCampaignElementTemplateType processCampaignElementTemplate(ProcessCampaignElementTemplateType aProcessCampaignElementTemplate)
aProcessCampaignElementTemplate
- The ProcessCampaignElementTemplate request document.public RespondCampaignElementTemplateType changeCampaignElementTemplate(ChangeCampaignElementTemplateType aChangeCampaignElementTemplate)
aChangeCampaignElementTemplate
- The ChangeCampaignElementTemplate request document.public ShowCampaignElementTemplateDataAreaType getCampaignElementTemplate(GetType getVerb) throws CampaignElementTemplateException
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.getVerb
- The get expression to execute.ShowCampaignElementTemplateDataArea
response when issuing the get expression.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.public java.util.List getCampaignElementTemplate(java.lang.String expressionLanguage, java.lang.String expression) throws CampaignElementTemplateException
expressionLanguage
- The expression language.expression
- The expression to return a list of CampaignElementTemplates.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.