com.ibm.commerce.wallet.facade.client

Class AbstractWalletFacadeClient


  • public abstract class AbstractWalletFacadeClient
extends AbstractBusinessObjectDocumentFacadeClient

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

    • Constructor Summary

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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      com.ibm.commerce.wallet.facade.datatypes.RespondWalletType changeWallet(com.ibm.commerce.wallet.facade.datatypes.ChangeWalletType aChangeWallet)
      This method will communicate with the Wallet facade and send the specified ChangeWallet request.
      com.ibm.commerce.wallet.facade.datatypes.RespondWalletItemType changeWalletItem(com.ibm.commerce.wallet.facade.datatypes.ChangeWalletItemType aChangeWalletItem)
      This method will communicate with the WalletItem facade and send the specified ChangeWalletItem request.
      com.ibm.commerce.wallet.facade.datatypes.ShowWalletDataAreaType getWallet(GetType getVerb)
      This method returns the ShowWalletDataArea when issuing the specified get expression to fetch Wallets.
      com.ibm.commerce.wallet.facade.datatypes.ShowWalletType getWallet(com.ibm.commerce.wallet.facade.datatypes.GetWalletType aGetWallet)
      This method will communicate with the Wallet facade and send the specified GetWallet.
      java.util.List getWallet(java.lang.String expressionLanguage, java.lang.String expression)
      This method returns a list of Wallets based on the expression specified.
      com.ibm.commerce.wallet.facade.datatypes.ShowWalletItemDataAreaType getWalletItem(GetType getVerb)
      This method returns the ShowWalletItemDataArea when issuing the specified get expression to fetch WalletItems.
      com.ibm.commerce.wallet.facade.datatypes.ShowWalletItemType getWalletItem(com.ibm.commerce.wallet.facade.datatypes.GetWalletItemType aGetWalletItem)
      This method will communicate with the Wallet facade and send the specified GetWalletItem.
      java.util.List getWalletItem(java.lang.String expressionLanguage, java.lang.String expression)
      This method returns a list of WalletItems based on the expression specified.
      com.ibm.commerce.wallet.facade.datatypes.AcknowledgeWalletType processWallet(com.ibm.commerce.wallet.facade.datatypes.ProcessWalletType aProcessWallet)
      This method will communicate with the Wallet facade and send the specified ProcessWallet request.
      com.ibm.commerce.wallet.facade.datatypes.AcknowledgeWalletItemType processWalletItem(com.ibm.commerce.wallet.facade.datatypes.ProcessWalletItemType aProcessWalletItem)
      This method will communicate with the Wallet facade and send the specified ProcessWalletItem request.
      ConfirmBODType syncWallet(com.ibm.commerce.wallet.facade.datatypes.SyncWalletType aSyncWallet)
      This method will communicate with the Wallet facade and send the specified SyncWallet request.
      ConfirmBODType syncWalletItem(com.ibm.commerce.wallet.facade.datatypes.SyncWalletItemType aSyncWalletItem)
      This method will communicate with the WalletItem facade and send the specified SyncWalletItem request.

      • 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

      • AbstractWalletFacadeClient

        public AbstractWalletFacadeClient()
        Creates an instance of the client to communicate with the Wallet facade.

      • AbstractWalletFacadeClient

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

      • getWallet

        public com.ibm.commerce.wallet.facade.datatypes.ShowWalletType getWallet(com.ibm.commerce.wallet.facade.datatypes.GetWalletType aGetWallet)
        This method will communicate with the Wallet facade and send the specified GetWallet. request.
        Parameters:
        aGetWallet - The GetWallet request document.
        Returns:
        The resulting ShowWallet response document.

      • processWallet

        public com.ibm.commerce.wallet.facade.datatypes.AcknowledgeWalletType processWallet(com.ibm.commerce.wallet.facade.datatypes.ProcessWalletType aProcessWallet)
        This method will communicate with the Wallet facade and send the specified ProcessWallet request.
        Parameters:
        aProcessWallet - The ProcessWallet request document.
        Returns:
        The resulting AcknowledgeWallet response document.

      • changeWallet

        public com.ibm.commerce.wallet.facade.datatypes.RespondWalletType changeWallet(com.ibm.commerce.wallet.facade.datatypes.ChangeWalletType aChangeWallet)
        This method will communicate with the Wallet facade and send the specified ChangeWallet request.
        Parameters:
        aChangeWallet - The ChangeWallet request document.
        Returns:
        The resulting RespondWallet response document.

      • syncWallet

        public ConfirmBODType syncWallet(com.ibm.commerce.wallet.facade.datatypes.SyncWalletType aSyncWallet)
        This method will communicate with the Wallet facade and send the specified SyncWallet request.
        Parameters:
        aSyncWallet - The SyncWallet request document.
        Returns:
        The resulting ConfirmBOD response document.

      • getWallet

        public com.ibm.commerce.wallet.facade.datatypes.ShowWalletDataAreaType getWallet(GetType getVerb)
                                                                          throws WalletException
        This method returns the ShowWalletDataArea when issuing the specified get expression to fetch Wallets. This method will be used by other framworks or methods that constructs the get expression.
        Parameters:
        getVerb - The get expression to execute.
        Returns:
        The ShowWalletDataArea response when issuing the get expression.
        Throws:
        WalletException - The WalletException is thrown if error information is found in the specified ShowWalletDataArea. This will represent that there was a problem when performing the operation.

      • getWallet

        public java.util.List getWallet(java.lang.String expressionLanguage,
                                java.lang.String expression)
                         throws WalletException
        This method returns a list of Wallets based on the expression specified.
        Parameters:
        expressionLanguage - The expression lanaguage.
        expression - The expression to return a list of Wallets.
        Returns:
        The list of Wallets that matches the expression specified.
        Throws:
        WalletException - The WalletException is thrown if error information is found in the specified ShowWalletDataArea. This will represent that there was a problem when performing the operation.

      • getWalletItem

        public com.ibm.commerce.wallet.facade.datatypes.ShowWalletItemType getWalletItem(com.ibm.commerce.wallet.facade.datatypes.GetWalletItemType aGetWalletItem)
        This method will communicate with the Wallet facade and send the specified GetWalletItem. request.
        Parameters:
        aGetWalletItem - The GetWalletItem request document.
        Returns:
        The resulting ShowWalletItem response document.

      • processWalletItem

        public com.ibm.commerce.wallet.facade.datatypes.AcknowledgeWalletItemType processWalletItem(com.ibm.commerce.wallet.facade.datatypes.ProcessWalletItemType aProcessWalletItem)
        This method will communicate with the Wallet facade and send the specified ProcessWalletItem request.
        Parameters:
        aProcessWalletItem - The ProcessWalletItem request document.
        Returns:
        The resulting AcknowledgeWalletItem response document.

      • changeWalletItem

        public com.ibm.commerce.wallet.facade.datatypes.RespondWalletItemType changeWalletItem(com.ibm.commerce.wallet.facade.datatypes.ChangeWalletItemType aChangeWalletItem)
        This method will communicate with the WalletItem facade and send the specified ChangeWalletItem request.
        Parameters:
        aChangeWalletItem - The ChangeWalletItem request document.
        Returns:
        The resulting RespondWalletItem response document.

      • syncWalletItem

        public ConfirmBODType syncWalletItem(com.ibm.commerce.wallet.facade.datatypes.SyncWalletItemType aSyncWalletItem)
        This method will communicate with the WalletItem facade and send the specified SyncWalletItem request.
        Parameters:
        aSyncWalletItem - The SyncWalletItem request document.
        Returns:
        The resulting ConfirmBOD response document.

      • getWalletItem

        public com.ibm.commerce.wallet.facade.datatypes.ShowWalletItemDataAreaType getWalletItem(GetType getVerb)
                                                                                  throws WalletItemException
        This method returns the ShowWalletItemDataArea when issuing the specified get expression to fetch WalletItems. This method will be used by other framworks or methods that constructs the get expression.
        Parameters:
        getVerb - The get expression to execute.
        Returns:
        The ShowWalletItemDataArea response when issuing the get expression.
        Throws:
        WalletItemException - The WalletItemException is thrown if error information is found in the specified ShowWalletItemDataArea. This will represent that there was a problem when performing the operation.

      • getWalletItem

        public java.util.List getWalletItem(java.lang.String expressionLanguage,
                                    java.lang.String expression)
                             throws WalletItemException
        This method returns a list of WalletItems based on the expression specified.
        Parameters:
        expressionLanguage - The expression lanaguage.
        expression - The expression to return a list of WalletItems.
        Returns:
        The list of WalletItems that matches the expression specified.
        Throws:
        WalletItemException - The WalletItemException is thrown if error information is found in the specified ShowWalletItemDataArea. This will represent that there was a problem when performing the operation.
Skip navigation links