com.ibm.commerce.giftcenter.facade.client

Class AbstractGiftCenterFacadeClient

java.lang.Object

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

com.ibm.commerce.giftcenter.facade.client.AbstractGiftCenterFacadeClient

Direct Known Subclasses:

GiftCenterFacadeClient

public abstract class AbstractGiftCenterFacadeClient
extends AbstractBusinessObjectDocumentFacadeClient

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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copyright notice field.

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

Method Summary

Modifier and Type	Method and Description
RespondGiftListType	changeGiftList(ChangeGiftListType aChangeGiftList) This method will communicate with the GiftList facade and send the specified ChangeGiftList request.
ShowGiftListType	getGiftList(GetGiftListType aGetGiftList) This method will communicate with the GiftCenter facade and send the specified GetGiftList.
ShowGiftListDataAreaType	getGiftList(GetType getVerb) This method returns the ShowGiftListDataArea when issuing the specified get expression to fetch GiftLists.
java.util.List	getGiftList(java.lang.String expressionLanguage, java.lang.String expression) This method returns a list of GiftLists based on the expression specified.
AcknowledgeGiftListType	processGiftList(ProcessGiftListType aProcessGiftList) This method will communicate with the GiftCenter facade and send the specified ProcessGiftList 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

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

Constructor Detail

AbstractGiftCenterFacadeClient

public AbstractGiftCenterFacadeClient()

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

AbstractGiftCenterFacadeClient

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

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

getGiftList

public ShowGiftListType getGiftList(GetGiftListType aGetGiftList)

This method will communicate with the GiftCenter facade and send the specified GetGiftList. request.

Parameters:

aGetGiftList - The GetGiftList request document.

Returns:

The resulting ShowGiftList response document.

processGiftList

public AcknowledgeGiftListType processGiftList(ProcessGiftListType aProcessGiftList)

This method will communicate with the GiftCenter facade and send the specified ProcessGiftList request.

Parameters:

aProcessGiftList - The ProcessGiftList request document.

Returns:

The resulting AcknowledgeGiftList response document.

changeGiftList

public RespondGiftListType changeGiftList(ChangeGiftListType aChangeGiftList)

This method will communicate with the GiftList facade and send the specified ChangeGiftList request.

Parameters:

aChangeGiftList - The ChangeGiftList request document.

Returns:

The resulting RespondGiftList response document.

getGiftList

public ShowGiftListDataAreaType getGiftList(GetType getVerb)
                                     throws GiftListException

This method returns the ShowGiftListDataArea when issuing the specified get expression to fetch GiftLists. This method will be used by other framworks or methods that constructs the get expression.

Parameters:

getVerb - The get expression to execute.

Returns:

The ShowGiftListDataArea response when issuing the get expression.

Throws:

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

getGiftList

public java.util.List getGiftList(java.lang.String expressionLanguage,
                                  java.lang.String expression)
                           throws GiftListException

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

Parameters:

expressionLanguage - The expression lanaguage.

expression - The expression to return a list of GiftLists.

Returns:

The list of GiftLists that matches the expression specified.

Throws:

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