com.ibm.commerce.installment.facade.client

Class AbstractInstallmentFacadeClient

java.lang.Object

com.ibm.commerce.foundation.client.facade.bod.AbstractBusinessObjectDocumentFacadeClient

com.ibm.commerce.installment.facade.client.AbstractInstallmentFacadeClient

Direct Known Subclasses:

InstallmentFacadeClient

public abstract class AbstractInstallmentFacadeClient
extends AbstractBusinessObjectDocumentFacadeClient

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

Field Summary

Fields inherited from class com.ibm.commerce.foundation.client.facade.bod.AbstractBusinessObjectDocumentFacadeClient

CHANGE_VERB_ACTION_ADD, CHANGE_VERB_ACTION_CHANGE, CHANGE_VERB_ACTION_CREATE, CHANGE_VERB_ACTION_DELETE, CHANGE_VERB_ACTION_UPDATE

Constructor Summary

Constructors

Constructor and Description
AbstractInstallmentFacadeClient() Creates an instance of the client to communicate with the Installment facade.
AbstractInstallmentFacadeClient(BusinessContextType businessContext, javax.security.auth.callback.CallbackHandler callbackHandler) Creates an instance of the client to communicate with the Installment facade.

Method Summary

Modifier and Type	Method and Description
com.ibm.commerce.installment.facade.datatypes.RespondInstallmentRuleType	changeInstallmentRule(com.ibm.commerce.installment.facade.datatypes.ChangeInstallmentRuleType aChangeInstallmentRule) This method will communicate with the InstallmentRule facade and send the specified ChangeInstallmentRule request.
com.ibm.commerce.installment.facade.datatypes.ShowCatalogEntryInstallmentPriceType	getCatalogEntryInstallmentPrice(com.ibm.commerce.installment.facade.datatypes.GetCatalogEntryInstallmentPriceType aGetCatalogEntryInstallmentPrice) This method will communicate with the Installment facade and send the specified GetCatalogEntryInstallmentPrice request.
com.ibm.commerce.installment.facade.datatypes.ShowCatalogEntryInstallmentPriceDataAreaType	getCatalogEntryInstallmentPrice(GetType getVerb) This method returns the ShowCatalogEntryInstallmentPriceDataArea when issuing the specified get expression to fetch CatalogEntryInstallmentPrices.
java.util.List	getCatalogEntryInstallmentPrice(java.lang.String expressionLanguage, java.lang.String expression) This method returns a list of CatalogEntryInstallmentPrices based on the expression specified.
com.ibm.commerce.installment.facade.datatypes.ShowInstallmentRuleType	getInstallmentRule(com.ibm.commerce.installment.facade.datatypes.GetInstallmentRuleType aGetInstallmentRule) This method will communicate with the Installment facade and send the specified GetInstallmentRule request.
com.ibm.commerce.installment.facade.datatypes.ShowInstallmentRuleDataAreaType	getInstallmentRule(GetType getVerb) This method returns the ShowInstallmentRuleDataArea when issuing the specified get expression to fetch InstallmentRules.
java.util.List	getInstallmentRule(java.lang.String expressionLanguage, java.lang.String expression) This method returns a list of InstallmentRules based on the expression specified.
com.ibm.commerce.installment.facade.datatypes.ShowOrderInstallmentPriceType	getOrderInstallmentPrice(com.ibm.commerce.installment.facade.datatypes.GetOrderInstallmentPriceType aGetOrderInstallmentPrice) This method will communicate with the Installment facade and send the specified GetOrderInstallmentPrice request.
com.ibm.commerce.installment.facade.datatypes.ShowOrderInstallmentPriceDataAreaType	getOrderInstallmentPrice(GetType getVerb) This method returns the ShowOrderInstallmentPriceDataArea when issuing the specified get expression to fetch OrderInstallmentPrices.
java.util.List	getOrderInstallmentPrice(java.lang.String expressionLanguage, java.lang.String expression) This method returns a list of OrderInstallmentPrices based on the expression specified.
com.ibm.commerce.installment.facade.datatypes.AcknowledgeInstallmentRuleType	processInstallmentRule(com.ibm.commerce.installment.facade.datatypes.ProcessInstallmentRuleType aProcessInstallmentRule) This method will communicate with the Installment facade and send the specified ProcessInstallmentRule request.

Methods inherited from class com.ibm.commerce.foundation.client.facade.bod.AbstractBusinessObjectDocumentFacadeClient

createActionExpression, createChangeVerb, createGetVerb, createGetVerb, createProcessVerb, createSyncVerb

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractInstallmentFacadeClient

public AbstractInstallmentFacadeClient()

Creates an instance of the client to communicate with the Installment facade.

AbstractInstallmentFacadeClient

public AbstractInstallmentFacadeClient(BusinessContextType businessContext,
                                       javax.security.auth.callback.CallbackHandler callbackHandler)

Creates an instance of the client to communicate with the Installment 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

getInstallmentRule

public com.ibm.commerce.installment.facade.datatypes.ShowInstallmentRuleType getInstallmentRule(com.ibm.commerce.installment.facade.datatypes.GetInstallmentRuleType aGetInstallmentRule)

This method will communicate with the Installment facade and send the specified GetInstallmentRule request.

Parameters:

aGetInstallmentRule - The GetInstallmentRule request document.

Returns:

The resulting ShowInstallmentRule response document.

processInstallmentRule

public com.ibm.commerce.installment.facade.datatypes.AcknowledgeInstallmentRuleType processInstallmentRule(com.ibm.commerce.installment.facade.datatypes.ProcessInstallmentRuleType aProcessInstallmentRule)

This method will communicate with the Installment facade and send the specified ProcessInstallmentRule request.

Parameters:

aProcessInstallmentRule - The ProcessInstallmentRule request document.

Returns:

The resulting AcknowledgeInstallmentRule response document.

changeInstallmentRule

public com.ibm.commerce.installment.facade.datatypes.RespondInstallmentRuleType changeInstallmentRule(com.ibm.commerce.installment.facade.datatypes.ChangeInstallmentRuleType aChangeInstallmentRule)

This method will communicate with the InstallmentRule facade and send the specified ChangeInstallmentRule request.

Parameters:

aChangeInstallmentRule - The ChangeInstallmentRule request document.

Returns:

The resulting RespondInstallmentRule response document.

getInstallmentRule

public com.ibm.commerce.installment.facade.datatypes.ShowInstallmentRuleDataAreaType getInstallmentRule(GetType getVerb)
                                                                                                 throws InstallmentRuleException

This method returns the ShowInstallmentRuleDataArea when issuing the specified get expression to fetch InstallmentRules. This method will be used by other frameworks or methods that constructs the get expression.

Parameters:

getVerb - The get expression to execute.

Returns:

The ShowInstallmentRuleDataArea response when issuing the get expression.

Throws:

InstallmentRuleException - The InstallmentRuleException is thrown if error information is found in the specified ShowInstallmentRuleDataArea. This will represent that there was a problem when performing the operation.

getInstallmentRule

public java.util.List getInstallmentRule(java.lang.String expressionLanguage,
                                         java.lang.String expression)
                                  throws InstallmentRuleException

This method returns a list of InstallmentRules based on the expression specified.

Parameters:

expressionLanguage - The expression language.

expression - The expression to return a list of InstallmentRules.

Returns:

The list of InstallmentRules that matches the expression specified.

Throws:

InstallmentRuleException - The InstallmentRuleException is thrown if error information is found in the specified ShowInstallmentRuleDataArea. This will represent that there was a problem when performing the operation.

getCatalogEntryInstallmentPrice

public com.ibm.commerce.installment.facade.datatypes.ShowCatalogEntryInstallmentPriceType getCatalogEntryInstallmentPrice(com.ibm.commerce.installment.facade.datatypes.GetCatalogEntryInstallmentPriceType aGetCatalogEntryInstallmentPrice)

This method will communicate with the Installment facade and send the specified GetCatalogEntryInstallmentPrice request.

Parameters:

aGetCatalogEntryInstallmentPrice - The GetCatalogEntryInstallmentPrice request document.

Returns:

The resulting ShowCatalogEntryInstallmentPrice response document.

getCatalogEntryInstallmentPrice

public com.ibm.commerce.installment.facade.datatypes.ShowCatalogEntryInstallmentPriceDataAreaType getCatalogEntryInstallmentPrice(GetType getVerb)
                                                                                                                           throws CatalogEntryInstallmentPriceException

This method returns the ShowCatalogEntryInstallmentPriceDataArea when issuing the specified get expression to fetch CatalogEntryInstallmentPrices. This method will be used by other frameworks or methods that constructs the get expression.

Parameters:

getVerb - The get expression to execute.

Returns:

The ShowCatalogEntryInstallmentPriceDataArea response when issuing the get expression.

Throws:

CatalogEntryInstallmentPriceException - The CatalogEntryInstallmentPriceException is thrown if error information is found in the specified ShowCatalogEntryInstallmentPriceDataArea. This will represent that there was a problem when performing the operation.

getCatalogEntryInstallmentPrice

public java.util.List getCatalogEntryInstallmentPrice(java.lang.String expressionLanguage,
                                                      java.lang.String expression)
                                               throws CatalogEntryInstallmentPriceException

This method returns a list of CatalogEntryInstallmentPrices based on the expression specified.

Parameters:

expressionLanguage - The expression language.

expression - The expression to return a list of CatalogEntryInstallmentPrices.

Returns:

The list of CatalogEntryInstallmentPrices that matches the expression specified.

Throws:

CatalogEntryInstallmentPriceException - The CatalogEntryInstallmentPriceException is thrown if error information is found in the specified ShowCatalogEntryInstallmentPriceDataArea. This will represent that there was a problem when performing the operation.

getOrderInstallmentPrice

public com.ibm.commerce.installment.facade.datatypes.ShowOrderInstallmentPriceType getOrderInstallmentPrice(com.ibm.commerce.installment.facade.datatypes.GetOrderInstallmentPriceType aGetOrderInstallmentPrice)

This method will communicate with the Installment facade and send the specified GetOrderInstallmentPrice request.

Parameters:

aGetOrderInstallmentPrice - The GetOrderInstallmentPrice request document.

Returns:

The resulting ShowOrderInstallmentPrice response document.

getOrderInstallmentPrice

public com.ibm.commerce.installment.facade.datatypes.ShowOrderInstallmentPriceDataAreaType getOrderInstallmentPrice(GetType getVerb)
                                                                                                             throws OrderInstallmentPriceException

This method returns the ShowOrderInstallmentPriceDataArea when issuing the specified get expression to fetch OrderInstallmentPrices. This method will be used by other frameworks or methods that constructs the get expression.

Parameters:

getVerb - The get expression to execute.

Returns:

The ShowOrderInstallmentPriceDataArea response when issuing the get expression.

Throws:

OrderInstallmentPriceException - The OrderInstallmentPriceException is thrown if error information is found in the specified ShowOrderInstallmentPriceDataArea. This will represent that there was a problem when performing the operation.

getOrderInstallmentPrice

public java.util.List getOrderInstallmentPrice(java.lang.String expressionLanguage,
                                               java.lang.String expression)
                                        throws OrderInstallmentPriceException

This method returns a list of OrderInstallmentPrices based on the expression specified.

Parameters:

expressionLanguage - The expression language.

expression - The expression to return a list of OrderInstallmentPrices.

Returns:

The list of OrderInstallmentPrices that matches the expression specified.

Throws:

OrderInstallmentPriceException - The OrderInstallmentPriceException is thrown if error information is found in the specified ShowOrderInstallmentPriceDataArea. This will represent that there was a problem when performing the operation.