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

• getWalletFactory

  protected com.ibm.commerce.wallet.facade.datatypes.WalletFactory getWalletFactory()
  

  This method will return the default instance of the Wallet Factory. This factory can be used to create objects defined by the Wallet.

  Returns:

  The default Wallet Factory.

• 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.

• checkAcknowledgeWallet

  protected com.ibm.commerce.wallet.facade.datatypes.AcknowledgeWalletDataAreaType checkAcknowledgeWallet(com.ibm.commerce.wallet.facade.datatypes.AcknowledgeWalletDataAreaType acknowledgeWalletDataArea)
                                                                                                   throws WalletException
  

  This method will examine the AcknowledgeWalletDataArea to see if there is any error information reported. If there is, then the WalletException will be thrown to represent the error. This method should be used by those methods that are performing a Process operation on a single Wallet.

  Parameters:

  acknowledgeWalletDataArea - The acknowledge Wallet data area to inspect.

  Returns:

  The specified AcknowledgeWalletDataArea if no error information is found.

  Throws:

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

• checkRespondWallet

  protected com.ibm.commerce.wallet.facade.datatypes.RespondWalletDataAreaType checkRespondWallet(com.ibm.commerce.wallet.facade.datatypes.RespondWalletDataAreaType respondWalletDataArea)
                                                                                           throws WalletException
  

  This method will examine the RespondWalletDataArea to see if there is any error information reported. If there is, then the WalletException will be thrown to represent the error. This method should be used by those methods that are performing a Process operation on a single Wallet.

  Parameters:

  respondWalletDataArea - The respond Wallet data area to inspect.

  Returns:

  The specified RespondWalletDataArea if no error information is found.

  Throws:

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

• checkShowWallet

  protected com.ibm.commerce.wallet.facade.datatypes.ShowWalletDataAreaType checkShowWallet(com.ibm.commerce.wallet.facade.datatypes.ShowWalletDataAreaType showWalletDataArea)
                                                                                     throws WalletException
  

  This method will examine the ShowWalletDataArea to see if there is any error information reported. If there is, then the WalletException will be thrown to represent the error. This method should be used by those methods that are performing a Process operation on a single Wallet.

  Parameters:

  showWalletDataArea - The show Wallet data area to inspect.

  Returns:

  The specified ShowWalletDataArea if no error information is found.

  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 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.

• checkAcknowledgeWalletItem

  protected com.ibm.commerce.wallet.facade.datatypes.AcknowledgeWalletItemDataAreaType checkAcknowledgeWalletItem(com.ibm.commerce.wallet.facade.datatypes.AcknowledgeWalletItemDataAreaType acknowledgeWalletItemDataArea)
                                                                                                           throws WalletItemException
  

  This method will examine the AcknowledgeWalletItemDataArea to see if there is any error information reported. If there is, then the WalletItemException will be thrown to represent the error. This method should be used by those methods that are performing a Process operation on a single WalletItem.

  Parameters:

  acknowledgeWalletItemDataArea - The acknowledge WalletItem data area to inspect.

  Returns:

  The specified AcknowledgeWalletItemDataArea if no error information is found.

  Throws:

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

• checkRespondWalletItem

  protected com.ibm.commerce.wallet.facade.datatypes.RespondWalletItemDataAreaType checkRespondWalletItem(com.ibm.commerce.wallet.facade.datatypes.RespondWalletItemDataAreaType respondWalletItemDataArea)
                                                                                                   throws WalletItemException
  

  This method will examine the RespondWalletItemDataArea to see if there is any error information reported. If there is, then the WalletItemException will be thrown to represent the error. This method should be used by those methods that are performing a Process operation on a single WalletItem.

  Parameters:

  respondWalletItemDataArea - The respond WalletItem data area to inspect.

  Returns:

  The specified RespondWalletItemDataArea if no error information is found.

  Throws:

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

• checkShowWalletItem

  protected com.ibm.commerce.wallet.facade.datatypes.ShowWalletItemDataAreaType checkShowWalletItem(com.ibm.commerce.wallet.facade.datatypes.ShowWalletItemDataAreaType showWalletItemDataArea)
                                                                                             throws WalletItemException
  

  This method will examine the ShowWalletItemDataArea to see if there is any error information reported. If there is, then the WalletItemException will be thrown to represent the error. This method should be used by those methods that are performing a Process operation on a single WalletItem.

  Parameters:

  showWalletItemDataArea - The show WalletItem data area to inspect.

  Returns:

  The specified ShowWalletItemDataArea if no error information is found.

  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 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.