DetermineSortedPaymentsCmdImpl

java.lang.Object
- MeasuredCacheableCommandImpl
- - com.ibm.commerce.command.AbstractECTargetableCommand
  - - com.ibm.commerce.command.TaskCommandImpl
    - - com.ibm.commerce.payment.rules.commands.DetermineSortedPaymentsCmdImpl

All Implemented Interfaces:

com.ibm.commerce.command.CacheableECCommand, ECCommand, ECTargetableCommand, TaskCommand, DetermineSortedPaymentsCmd, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, com.ibm.websphere.command.TargetableCommand, java.io.Serializable
```
public class DetermineSortedPaymentsCmdImpl
extends TaskCommandImpl
implements DetermineSortedPaymentsCmd
```
This is the implementation class of the task command DetermineSortedPaymentsCmd. It builds the relationship between releases and payments according to the algorithm described in the business logic. The relationship will be stored in the table "EDPRELHIST". Each relationship associates an order release with a payment recorded in the table "EDPPAYHIST".
1. Input parameters:
  paymentContainer: All available com.ibm.commerce.payment.rules.AtomicPaymentToBackendLinkObject objects which can be used. Each com.ibm.commerce.payment.rules.AtomicPaymentToBackendLinkObject object corresponds to an available payment object. This parameter is passed in by setPaymentContainer(Collection).
  
  releasesWithAmount: The LinkedHashMap object containing all releases to process. The key of this LinkedHashMap is ID of the release object with Long type. The value of this LinkedHashMap is the amount with BigDecimal that needs to process of the corresponding release. This parameter should be set to the request properties in the command context with the key "releasesWithAmount".
2. Business Logic:
  Step 1. This class firstly iterates the releases in input collection. For each release, this class checks all of the payments in the payment container passed in. If the items of this release include the items associated with the payment object, then relationship will be built between this release and the payment. Also those payment objects which are built relationship with release in this step will be put into the resulting payment container. They will be in the beginning position of the resulting payment container. This is to notify the payment rules engine to pick up these payment with the highest priority when it calculates payment actions for the releases.
  
  Step 2. This class then iterates the releases which have not been built relationship with any payment objects. For each release, this class checks all of the payments which have not been built relationship with any releases. If the total amount of this release equals to the available amount of one payment, the relationship is built between this release and the payment. At once a release is built relationship with any one payment object here, the iteration for this release will exit. That is, one release would be built relationship with at most one payment object here. Also those payment objects which are built relationship with release in this step will be put into resulting container. The position of these payment objects is after the payment objects of step 1 in the payment container. The remaining payments which have not been built relationship with any releases just keep original order. But they will be at the last part of the resulting payment container.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CLASS_NAME
Class name

static java.lang.String COPYRIGHT
The internal copyright field.
- Fields inherited from class com.ibm.commerce.command.AbstractECTargetableCommand
  commandContext
- Fields inherited from interface com.ibm.commerce.payment.rules.commands.DetermineSortedPaymentsCmd
  defaultCommandClassName, NAME
- Fields inherited from interface com.ibm.websphere.command.Command
  serialVersionUID

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CLASS_NAME` Class name
`static java.lang.String`	`COPYRIGHT` The internal copyright field.

Constructor Summary

Constructors
Constructor and Description

DetermineSortedPaymentsCmdImpl()

Constructors
Constructor and Description
`DetermineSortedPaymentsCmdImpl()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected java.util.Collection`	`createPaymentToReleaseRelationshipsByAmount(java.util.Collection localPaymentContainer)` This method builds the relationship between the payments and releases and returns the payments that match with one of the releases by amount.
`protected java.util.Collection`	`createPaymentToReleaseRelationshipsByItem(java.util.Collection localPaymentContainer)` This method builds the relationship between the payments and releases and returns the payments who match with one of the releases by item.
`protected com.ibm.commerce.edp.model.ObjectModelFacadeLocal`	`getObjectModelFacade()` This method returns the `ObjectModelFacadeLocal`.
`java.lang.Long`	`getOrderId()` This method returns the current order ID.
`java.util.Collection`	`getPaymentContainer()` This method gets the payment container passed in.
`java.util.LinkedHashMap`	`getReleases()` This method gets the collection containing numbers of the release in process.
`void`	`performExecute()` The main business logic of this command.
`protected void`	`putReleaseToPaymentRelationshipInCommandContext(java.lang.Long releaseId, AtomicPaymentToBackendLinkObject aprac)` This method puts the relationship between the current releases and payments into command context.
`void`	`setOrderId(java.lang.Long orderIdentifier)` This method sets the current order ID.
`void`	`setPaymentContainer(java.util.Collection container)` This method sets the payment container passed in.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.ibm.commerce.command.CacheableECCommand
execute

Methods inherited from interface com.ibm.websphere.command.CacheableCommand
executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, updateCache

Methods inherited from interface com.ibm.websphere.command.TargetableCommand
getCommandTarget, getCommandTargetName, hasOutputProperties, setCommandTarget, setCommandTargetName, setOutputProperties

Methods inherited from interface com.ibm.websphere.command.Command
isReadyToCallExecute, reset

Methods inherited from interface com.ibm.websphere.command.CommandCaller
unionDependencies

Methods inherited from interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

- Field Detail
  - COPYRIGHT
```
public static final java.lang.String COPYRIGHT
```
    The internal copyright field.
    
    See Also:
    
    Constant Field Values
  - CLASS_NAME
```
public static final java.lang.String CLASS_NAME
```
    Class name
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DetermineSortedPaymentsCmdImpl
```
public DetermineSortedPaymentsCmdImpl()
```
- Method Detail
  - getReleases
```
public java.util.LinkedHashMap getReleases()
                                    throws ECException
```
    This method gets the collection containing numbers of the release in process.
    
    Returns:
    
    the LinkedHashMap object in the request properties
    
    Throws:
    
    ECException - in case of exceptional situations
  - getPaymentContainer
```
public java.util.Collection getPaymentContainer()
```
    This method gets the payment container passed in.
    
    Specified by:
    
    getPaymentContainer in interface DetermineSortedPaymentsCmd
    
    Returns:
    
    the payment container passed in
  - setPaymentContainer
```
public void setPaymentContainer(java.util.Collection container)
```
    This method sets the payment container passed in.
    
    Specified by:
    
    setPaymentContainer in interface DetermineSortedPaymentsCmd
    
    Parameters:
    
    container - the payment container passed in
  - setOrderId
```
public void setOrderId(java.lang.Long orderIdentifier)
```
    This method sets the current order ID.
    
    Specified by:
    
    setOrderId in interface DetermineSortedPaymentsCmd
    
    Parameters:
    
    orderIdentifier - the current order ID
  - getOrderId
```
public java.lang.Long getOrderId()
```
    This method returns the current order ID.
    
    Returns:
    
    the current order ID
  - performExecute
```
public void performExecute()
                    throws ECException
```
    The main business logic of this command.
    
    Specified by:
    
    performExecute in interface ECCommand
    
    Specified by:
    
    performExecute in interface com.ibm.websphere.command.TargetableCommand
    
    Overrides:
    
    performExecute in class AbstractECTargetableCommand
    
    Throws:
    
    ECException - in case of exceptional situation
  - createPaymentToReleaseRelationshipsByItem
```
protected java.util.Collection createPaymentToReleaseRelationshipsByItem(java.util.Collection localPaymentContainer)
                                                                  throws ECException
```
    This method builds the relationship between the payments and releases and returns the payments who match with one of the releases by item. One payment has its associated items that were associated with the payment when the order was approved. If the associated items for the payment include all the items in the release, then the payment matches the release by item. Then the relationship between the payment and the release will be built, and the payment will be put into the resulting list of this method.
    
    Parameters:
    
    localPaymentContainer - the payment container containing all payments
    
    Returns:
    
    the payments that is associated with one of the releases by item.
    
    Throws:
    
    ECException - in case of exceptional situations
  - putReleaseToPaymentRelationshipInCommandContext
```
protected void putReleaseToPaymentRelationshipInCommandContext(java.lang.Long releaseId,
                                                   AtomicPaymentToBackendLinkObject aprac)
                                                        throws ECException
```
    This method puts the relationship between the current releases and payments into command context.
    
    Parameters:
    
    releaseId - the current release ID
    
    aprac - the AtomicPaymentToBackendLinkObject object that corresponds to current payment object.
    
    Throws:
    
    ECException - in case of the exceptional situations
  - createPaymentToReleaseRelationshipsByAmount
```
protected java.util.Collection createPaymentToReleaseRelationshipsByAmount(java.util.Collection localPaymentContainer)
                                                                    throws ECException
```
    This method builds the relationship between the payments and releases and returns the payments that match with one of the releases by amount. For each release, this method checks if there is a payment who has the same amount. If so, then it puts the payment to the collection to be returned, and builds the relationship between this payment and this release.
    
    Parameters:
    
    localPaymentContainer - the payment container containing all payments
    
    Returns:
    
    the payments with amount match with the releases.
    
    Throws:
    
    ECException - in case of exceptional situations
  - getObjectModelFacade
```
protected com.ibm.commerce.edp.model.ObjectModelFacadeLocal getObjectModelFacade()
                                                                          throws J2EEException
```
    This method returns the ObjectModelFacadeLocal.
    
    Returns:
    
    An instance of ObjectModelFacadeLocal.
    
    Throws:
    
    J2EEException

Class DetermineSortedPaymentsCmdImpl

Field Summary

Fields inherited from class com.ibm.commerce.command.AbstractECTargetableCommand

Fields inherited from interface com.ibm.commerce.payment.rules.commands.DetermineSortedPaymentsCmd

Fields inherited from interface com.ibm.websphere.command.Command

Constructor Summary

Method Summary

Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand

Methods inherited from class java.lang.Object

Methods inherited from interface com.ibm.commerce.command.CacheableECCommand

Methods inherited from interface com.ibm.websphere.command.CacheableCommand

Methods inherited from interface com.ibm.websphere.command.TargetableCommand

Methods inherited from interface com.ibm.websphere.command.Command

Methods inherited from interface com.ibm.websphere.command.CommandCaller

Methods inherited from interface com.ibm.commerce.command.ECCommand

Field Detail

COPYRIGHT

CLASS_NAME

Constructor Detail

DetermineSortedPaymentsCmdImpl

Method Detail

getReleases

getPaymentContainer

setPaymentContainer

setOrderId

getOrderId

performExecute

createPaymentToReleaseRelationshipsByItem

putReleaseToPaymentRelationshipInCommandContext

createPaymentToReleaseRelationshipsByAmount

getObjectModelFacade