Field Detail

• COPYRIGHT

  static final java.lang.String COPYRIGHT
  

  The IBM copyright notice field.

  See Also:

  Constant Field Values

Method Detail

• createMerchant

  com.ibm.commerce.payments.plugincontroller.beans.MerchantAccessBean createMerchant(java.lang.String merchantName,
                                                                                   java.lang.Long memberId)
                                                                                     throws InvalidDataException,
                                                                                            InternalException,
                                                                                            java.rmi.RemoteException
  

  This method creates a merchant in WebSphere Commerce, which represents the payment perspective for a store. Since here the state is not included in the parameter list, the merchant is created with state 1 default.

  Parameters:

  merchantName - A String that specifies the current merchant name.

  memberId - A Long that specifies the owner of the new merchant.

  Returns:

  The merchant access bean.

  Throws:

  InvalidDataException - This exception is thrown when the parameters are invalid.

  InternalException - This exception is thrown in case of EJB error.

  java.rmi.RemoteException

• createMerchant

  com.ibm.commerce.payments.plugincontroller.beans.MerchantAccessBean createMerchant(java.lang.String merchantName,
                                                                                   java.lang.Long memberId,
                                                                                   java.lang.Boolean state)
                                                                                     throws InvalidDataException,
                                                                                            InternalException,
                                                                                            java.rmi.RemoteException
  

  This method creates a merchant in WebSphere Commerce, which represents the payment perspective for a store.

  Parameters:

  merchantName - A String that specifies the current merchant name.

  memberId - A Long that specifies the owner of the new merchant.

  state - A Boolean that indicates the state of the merchant.

  Returns:

  The merchant access bean.

  Throws:

  InvalidDataException - This exception is thrown when the parameters are invalid.

  InternalException - This exception is thrown in case of EJB error.

  java.rmi.RemoteException

• createMerchantConf

  com.ibm.commerce.payments.plugincontroller.beans.MerchantConfAccessBean createMerchantConf(java.lang.Long merchantId,
                                                                                           java.lang.String paymentSystemName,
                                                                                           java.lang.String paymentConfigurationGroup)
                                                                                             throws InvalidDataException,
                                                                                                    InternalException,
                                                                                                    java.rmi.RemoteException
  

  This method creates a merchant configuration which means for a specific merchant, which payment system and payment configuration group are used.

  Parameters:

  merchantId - A Long that specifies the merchant id this merchant configuration belongs to.

  paymentSystemName - A String that specifies the current payment system name.

  paymentConfigurationGroup - A String that specifies the current payment configuration group.

  Returns:

  The merchant configuration access bean.

  Throws:

  InvalidDataException - This exception is thrown when the parameters are invalid.

  InternalException - This exception is thrown in case of EJB error.

  java.rmi.RemoteException

• mapStoreMerchant

  com.ibm.commerce.payments.plugincontroller.beans.StoreMerchantAccessBean mapStoreMerchant(java.lang.Integer storeId,
                                                                                          java.lang.Long merchantId)
                                                                                            throws InvalidDataException,
                                                                                                   InternalException,
                                                                                                   java.rmi.RemoteException
  

  This method creates the association between the store and the merchant.

  Parameters:

  storeId - An Integer that specifies the current store id.

  merchantId - A Long that specifies the current merchant id.

  Returns:

  The Store merchant.

  Throws:

  InvalidDataException - This exception is thrown when the parameters are invalid.

  InternalException - This exception is thrown in case of EJB error.

  java.rmi.RemoteException

• putMerchantConfInfo

  com.ibm.commerce.payments.plugincontroller.beans.MerchantConfInfoAccessBean putMerchantConfInfo(java.lang.Long merchConfId,
                                                                                                java.lang.String name,
                                                                                                java.lang.String value,
                                                                                                boolean encrypted)
                                                                                                  throws InvalidDataException,
                                                                                                         InternalException,
                                                                                                         java.rmi.RemoteException
  

  This method creates a property for the specific merchant configuration id. There the value of this property should be encrypted configured in a single XML file. This XML file specifies which property should be encrypted according to the property name.

  Parameters:

  merchConfId - A Long that specifies the merchant configuration id that the merchant configuration information belongs to.

  name - A String that specifies the property name.

  value - A String that specifies the property value.

  encrypted - A boolean that indicates if the property needs encrypt.

  Returns:

  The Merchant configuration information.

  Throws:

  InvalidDataException - This exception is thrown when the parameters are invalid.

  InternalException - This exception is thrown in case of EJB error.

  java.rmi.RemoteException

• putMerchantConfInfo

  void putMerchantConfInfo(java.lang.Long merchConfId,
                         java.util.Hashtable properties)
                           throws InvalidDataException,
                                  InternalException,
                                  java.rmi.RemoteException,
                                  ConfigException
  

  This method creates the properties for the specific merchant configuration id by taking a hashtable as input.

  Parameters:

  merchConfId - A Long that specifies the merchant configuration id that the merchant configuration information belongs to.

  properties - A Hashtable that represents the properties will be put into the database.

  Throws:

  InvalidDataException - This exception is thrown when the parameters are invalid.

  InternalException - This exception is thrown in case of EJB error.

  java.rmi.RemoteException

  ConfigException

• activateMerchant

  void activateMerchant(java.lang.Long merchantId)
                        throws InvalidDataException,
                               InternalException,
                               java.rmi.RemoteException
  

  This method activates the merchant with the specific merchant id.

  Parameters:

  merchantId - A Long that specifies the current merchant id.

  Throws:

  InvalidDataException - This exception is thrown when the parameters are invalid.

  InternalException - This exception is thrown in case of EJB error.

  java.rmi.RemoteException

• deactivateMerchant

  void deactivateMerchant(java.lang.Long merchantId)
                          throws InvalidDataException,
                                 InternalException,
                                 java.rmi.RemoteException
  

  This method deactivates the merchant with the specific merchant id.

  Parameters:

  merchantId - A Long that specifies the current merchant id.

  Throws:

  InvalidDataException - This exception is thrown when the parameters are invalid.

  InternalException - This exception is thrown in case of EJB error.

  java.rmi.RemoteException

• editStoreMerchant

  void editStoreMerchant(java.lang.Integer storeId,
                       java.lang.Long merchantId)
                         throws InvalidDataException,
                                InternalException,
                                java.rmi.RemoteException
  

  This method edits the association between the store and the merchant, which updates the store to be mapped to another merchant with merchantId.

  Parameters:

  storeId - An Integer that specifies the current store id.

  merchantId - A Long that specifies the new merchant id that will be associated with current store.

  Throws:

  InvalidDataException - This exception is thrown when the parameters are invalid.

  InternalException - This exception is thrown in case of EJB error.

  java.rmi.RemoteException

• editMerchantConfInfo

  void editMerchantConfInfo(java.lang.Long merchConfId,
                          java.lang.String name,
                          java.lang.String value,
                          boolean encrypted)
                            throws InvalidDataException,
                                   InternalException,
                                   java.rmi.RemoteException
  

  This method edits the property value with specific name to a new value of the merchant configuration.

  Parameters:

  merchConfId - A Long that specifies the current merchant configuration id the property with name belongs to.

  name - A String that specifies the property name.

  value - A String that specifies the new value of this property with name.

  encrypted - A String that indicates if the property needs encrypt.

  Throws:

  InvalidDataException - This exception is thrown when the parameters are invalid.

  InternalException - This exception is thrown in case of EJB error.

  java.rmi.RemoteException

• editMerchantConfInfo

  void editMerchantConfInfo(java.lang.Long merchConfId,
                          java.util.Hashtable properties)
                            throws InvalidDataException,
                                   InternalException,
                                   java.rmi.RemoteException,
                                   ConfigException
  

  This method edits the properties for the specific merchant configuration id.

  Parameters:

  merchConfId - A Long that specifies the current merchant configuration id the properties in the hashtable belongs to.

  properties - A Hashtable that contains the properties to be updated with new values.

  Throws:

  InvalidDataException - This exception is thrown when the parameters are invalid.

  InternalException - This exception is thrown in case of EJB error.

  java.rmi.RemoteException

  ConfigException

• deleteMerchant

  void deleteMerchant(java.lang.Long merchantId)
                      throws InvalidDataException,
                             InternalException,
                             java.rmi.RemoteException
  

  This method deletes the specific merchant with merchant id.

  Parameters:

  merchantId - A Long that specifies the current merchant id.

  Throws:

  InvalidDataException - This exception is thrown when the parameters are invalid.

  InternalException - This exception is thrown in case of EJB error.

  java.rmi.RemoteException

• deleteStoreMerchant

  void deleteStoreMerchant(java.lang.Integer storeId)
                           throws InvalidDataException,
                                  InternalException,
                                  java.rmi.RemoteException
  

  This method deletes the association between the store and the merchant.

  Parameters:

  storeId - An Integer that specifies the current store id.

  Throws:

  InvalidDataException - This exception is thrown when the parameters are invalid.

  InternalException - This exception is thrown in case of EJB error.

  java.rmi.RemoteException

• deleteMerchantConf

  void deleteMerchantConf(java.lang.Long merchConfId)
                          throws InvalidDataException,
                                 InternalException,
                                 java.rmi.RemoteException
  

  This method deletes the merchant configuration with merchant configuration id.

  Parameters:

  merchConfId - A Long that specifies the current merchant configuration id.

  Throws:

  InvalidDataException - This exception is thrown when the parameters are invalid.

  InternalException - This exception is thrown in case of EJB error.

  java.rmi.RemoteException

• deleteMerchantConfInfo

  void deleteMerchantConfInfo(java.lang.Long merchConfId)
                              throws InvalidDataException,
                                     InternalException,
                                     java.rmi.RemoteException
  

  This method deletes all properties for the merchant configuration.

  Parameters:

  merchConfId - A Long that specifies the current merchant configuration id.

  Throws:

  InvalidDataException - This exception is thrown when the parameters are invalid.

  InternalException - This exception is thrown in case of EJB error.

  java.rmi.RemoteException

• deleteMerchantConfInfo

  void deleteMerchantConfInfo(java.lang.Long merchConfId,
                            java.lang.String name)
                              throws InvalidDataException,
                                     InternalException,
                                     java.rmi.RemoteException
  

  This method deletes the specific property with name for the merchant configuration.

  Parameters:

  merchConfId - A Long that specifies the current merchant configuration id the property belongs to.

  name - A String that specifies the current property name.

  Throws:

  InvalidDataException - This exception is thrown when the parameters are invalid.

  InternalException - This exception is thrown in case of EJB error.

  java.rmi.RemoteException

• deleteMerchantConfInfo

  void deleteMerchantConfInfo(java.lang.Long merchConfId,
                            java.util.ArrayList properties)
                              throws InvalidDataException,
                                     InternalException,
                                     java.rmi.RemoteException
  

  This method deletes all properties in the array list for the merchant configuration.

  Parameters:

  merchConfId - A Long that specifies the current merchant configuration id the properties belong to.

  properties - An ArrayList that represents the properties need to be deleted.

  Throws:

  InvalidDataException - This exception is thrown when the parameters are invalid.

  InternalException - This exception is thrown in case of EJB error.

  java.rmi.RemoteException

• getMerchant

  java.util.Collection getMerchant(java.lang.String name,
                                 java.lang.Long memberId)
                                   throws InvalidDataException,
                                          InternalException,
                                          java.rmi.RemoteException
  

  This method returns all merchants with the specific attributes.

  Parameters:

  name - A String that specifies the current name.

  memberId - A Long that specifies the owner of the merchant.

  Returns:

  A Collection that contains all merchants with the specific attributes.

  Throws:

  InvalidDataException - This exception is thrown when the parameters are invalid.

  InternalException - This exception is thrown in case of EJB error.

  java.rmi.RemoteException

• getMerchantById

  com.ibm.commerce.payments.plugincontroller.beans.MerchantAccessBean getMerchantById(java.lang.Long merchantId)
                                                                                      throws InvalidDataException,
                                                                                             InternalException,
                                                                                             java.rmi.RemoteException
  

  This method returns the merchant with specific merchant id.

  Parameters:

  merchantId - A Long that specifies the current merchant id.

  Returns:

  The MerchantAccessBean with merchantId.

  Throws:

  InvalidDataException - This exception is thrown when the parameters are invalid.

  InternalException - This exception is thrown in case of EJB error.

  java.rmi.RemoteException

• getMerchantConf

  java.util.Collection getMerchantConf(java.lang.Long merchantId)
                                       throws InvalidDataException,
                                              InternalException,
                                              java.rmi.RemoteException
  

  This method returns all merchant configurations according to the input parameters.

  Parameters:

  merchantId - A Long that specifies the current merchant id.

  Returns:

  A Collection that contains all merchant configurations with merchantId

  Throws:

  InvalidDataException - This exception is thrown when the parameters are invalid.

  InternalException - This exception is thrown in case of EJB error.

  java.rmi.RemoteException

• getMerchantConf

  java.util.Collection getMerchantConf(java.lang.Long merchantId,
                                     java.lang.String paymentSystemName,
                                     java.lang.String paymentConfigurationGroup)
                                       throws InvalidDataException,
                                              InternalException,
                                              java.rmi.RemoteException
  

  This method returns all merchant configurations according to the input parameters.

  Parameters:

  merchantId - A Long that specifies the current merchant id.

  paymentSystemName - A String that specifies the current payment system name.

  paymentConfigurationGroup - A String that specifies the current payment configuration group.

  Returns:

  A Collection that contains all merchant configurations with merchantId.

  Throws:

  InvalidDataException - This exception is thrown when the parameters are invalid.

  InternalException - This exception is thrown in case of EJB error.

  java.rmi.RemoteException

• getStoreMerchantByStoreId

  com.ibm.commerce.payments.plugincontroller.beans.StoreMerchantAccessBean getStoreMerchantByStoreId(java.lang.Integer storeId)
                                                                                                     throws InvalidDataException,
                                                                                                            InternalException,
                                                                                                            java.rmi.RemoteException
  

  This method returns the association between store and merchant with the specific store id.

  Parameters:

  storeId - An Integer that specifies the current store id.

  Returns:

  The association between store and merchant.

  Throws:

  InvalidDataException - This exception is thrown when the parameters are invalid.

  InternalException - This exception is thrown in case of EJB error.

  java.rmi.RemoteException

• getStoreMerchantByMerchantId

  java.util.Collection getStoreMerchantByMerchantId(java.lang.Long merchantId)
                                                    throws InvalidDataException,
                                                           InternalException,
                                                           java.rmi.RemoteException
  

  This method returns all association with current merchant id.

  Parameters:

  merchantId - A Long that specifies the current merchant id.

  Returns:

  A Collection that contains all association with merhcantId.

  Throws:

  InvalidDataException - This exception is thrown when the parameters are invalid.

  InternalException - This exception is thrown in case of EJB error.

  java.rmi.RemoteException

• getMerchantConfById

  com.ibm.commerce.payments.plugincontroller.beans.MerchantConfAccessBean getMerchantConfById(java.lang.Long merchantConfId)
                                                                                              throws InvalidDataException,
                                                                                                     InternalException,
                                                                                                     java.rmi.RemoteException
  

  This method returns the merchant configuration with merchant configuration id.

  Parameters:

  merchantConfId - A Long that specifies the current merchant configuration id.

  Returns:

  The current merchant configuration with merchant configuration id.

  Throws:

  InvalidDataException - This exception is thrown when the parameters are invalid.

  InternalException - This exception is thrown in case of EJB error.

  java.rmi.RemoteException

• getMerchantConfInfoById

  com.ibm.commerce.payments.plugincontroller.beans.MerchantConfInfoAccessBean getMerchantConfInfoById(java.lang.Long merchantConfInfoId)
                                                                                                      throws InvalidDataException,
                                                                                                             InternalException,
                                                                                                             java.rmi.RemoteException
  

  This method returns the merchant configuration information according to the merchant configuration information id.

  Parameters:

  merchantConfInfoId - A Long that specifies the current merchant configuration information id.

  Returns:

  The current MerchantConfInfoAccessBean with merchantConfInfoId.

  Throws:

  InvalidDataException - This exception is thrown when the parameters are invalid.

  InternalException - This exception is thrown in case of EJB error.

  java.rmi.RemoteException

• getMerchantConfInfo

  java.util.Collection getMerchantConfInfo(java.lang.Long merchConfId)
                                           throws InvalidDataException,
                                                  InternalException,
                                                  java.rmi.RemoteException
  

  This method returns all merchant configuration information according to the input parameter.

  Parameters:

  merchConfId - A Long that specifies the current merchant configuration id.

  Returns:

  A Collection that contains all merchant configuration information with merchantConfId.

  Throws:

  InvalidDataException - This exception is thrown when the parameters are invalid.

  InternalException - This exception is thrown in case of EJB error.

  java.rmi.RemoteException

• getMerchantConfInfo

  java.util.Collection getMerchantConfInfo(java.lang.Long merchConfId,
                                         java.lang.String name)
                                           throws InvalidDataException,
                                                  InternalException,
                                                  java.rmi.RemoteException
  

  This method returns all merchant configuration information according to the input parameter.

  Parameters:

  merchConfId - A Long that specifies the current merchant configuration id.

  name - A String that specifies the property name

  Returns:

  A Collection that contains all merchant configuration information with merchantConfId.

  Throws:

  InvalidDataException - This exception is thrown when the parameters are invalid.

  InternalException - This exception is thrown in case of EJB error.

  java.rmi.RemoteException