com.ibm.commerce.order.facade.server.external

Class AbstractExternalOrderFacadeClient

java.lang.Object

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

com.ibm.commerce.order.facade.server.external.AbstractExternalOrderFacadeClient

public class AbstractExternalOrderFacadeClient
extends AbstractBusinessObjectDocumentFacadeClient

This class provides a set of methods that can be used to communicate with the Order facade. This class represents a library of Order operations that can be performed. It provides out bound services with external system.

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

Method Summary

Modifier and Type	Method and Description
RespondOrderType	changeOrder(ChangeOrderType aChangeOrder) This method communicates with the External Order facade and sends the specified Change request.
ShowOrderType	getOrder(GetOrderType aGetOrder) This method will communicate with the Order facade and send the specified GetOrder.
ShowOrderDataAreaType	getOrder(GetType getVerb) This method returns the ShowOrderDataArea when issuing the specified get expression to fetch Orders.
java.util.List	getOrder(java.lang.String expressionLanguage, java.lang.String expression) This method returns a list of Orders based on the expression specified.
ShowQuoteType	getQuote(GetQuoteType aGetQuote) This method will communicate with the Order facade and send the specified GetQuote.
ShowQuoteDataAreaType	getQuote(GetType getVerb) This method returns the ShowQuoteDataArea when issuing the specified get expression to fetch Quotes.
java.util.List	getQuote(java.lang.String expressionLanguage, java.lang.String expression) This method returns a list of Quotes based on the expression specified.
AcknowledgeOrderType	processOrder(ProcessOrderType aProcessOrder) This method communicates with the External Order facade and sends the specified ProcessOrder request.
AcknowledgeQuoteType	processQuote(ProcessQuoteType aProcessQuote) This method will communicate with the Order facade and send the specified ProcessQuote 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

AbstractExternalOrderFacadeClient

public AbstractExternalOrderFacadeClient()

Creates an instance of the client to communicate with the External Order facade.

AbstractExternalOrderFacadeClient

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

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

getOrder

public ShowOrderType getOrder(GetOrderType aGetOrder)

This method will communicate with the Order facade and send the specified GetOrder. request.

Parameters:

aGetOrder - The GetOrder request document.

Returns:

The resulting ShowOrder response document.

processOrder

public AcknowledgeOrderType processOrder(ProcessOrderType aProcessOrder)

This method communicates with the External Order facade and sends the specified ProcessOrder request.

Parameters:

aProcessOrder - The ProcessOrder request document.

Returns:

The resulting AcknowledgeOrder response document.

changeOrder

public RespondOrderType changeOrder(ChangeOrderType aChangeOrder)

This method communicates with the External Order facade and sends the specified Change request.

Parameters:

aChangeOrder - The ChangeOrder request document.

Returns:

The resulting RespondOrderType response document.

getOrder

public ShowOrderDataAreaType getOrder(GetType getVerb)
                               throws OrderException

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

Parameters:

getVerb - The get expression to execute.

Returns:

The ShowOrderDataArea response when issuing the get expression.

Throws:

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

getOrder

public java.util.List getOrder(java.lang.String expressionLanguage,
                               java.lang.String expression)
                        throws OrderException

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

Parameters:

expressionLanguage - The expression language.

expression - The expression to return a list of Orders.

Returns:

The list of Orders that matches the expression specified.

Throws:

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

getQuote

public ShowQuoteType getQuote(GetQuoteType aGetQuote)

This method will communicate with the Order facade and send the specified GetQuote. request.

Parameters:

aGetQuote - The GetQuote request document.

Returns:

The resulting ShowQuote response document.

processQuote

public AcknowledgeQuoteType processQuote(ProcessQuoteType aProcessQuote)

This method will communicate with the Order facade and send the specified ProcessQuote request.

Parameters:

aProcessQuote - The ProcessQuote request document.

Returns:

The resulting AcknowledgeQuote response document.

getQuote

public ShowQuoteDataAreaType getQuote(GetType getVerb)
                               throws QuoteException

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

Parameters:

getVerb - The get expression to execute.

Returns:

The ShowQuoteDataArea response when issuing the get expression.

Throws:

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

getQuote

public java.util.List getQuote(java.lang.String expressionLanguage,
                               java.lang.String expression)
                        throws QuoteException

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

Parameters:

expressionLanguage - The expression language.

expression - The expression to return a list of Quotes.

Returns:

The list of Quotes that matches the expression specified.

Throws:

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