Class PaymentSummaryGenerateCmdImpl

  • All Implemented Interfaces:
    AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, PaymentSummaryGenerateCmd, Protectable,,,,,,

    public class PaymentSummaryGenerateCmdImpl
    extends ControllerCommandImpl
    implements PaymentSummaryGenerateCmd
    This is the default implementation of the PayCleanupCmd controller command.


    • It Generates payment summary records for a Store by account by payment policy for charged amounts captured since this command last ran.
    • This command is normally run as a Store level scheduled command and takes the storeId as parameter.

    Input parameters:

    Name Description
    storeId The reference number of the store associated with this command.

    Output parameters:


    Task commands called:

    See Also:
    Serialized Form
    • Constructor Detail

      • PaymentSummaryGenerateCmdImpl

        public PaymentSummaryGenerateCmdImpl()
    • Method Detail

      • getResources

        public AccessVector getResources()
                                  throws ECException
        This method returns the resources accessed by this command. For this command, the resources accessed are the Store and the Accounts for which payment summary records are to be generated.
        Specified by:
        getResources in interface ECCommand
        getResources in class AbstractECTargetableCommand
        An AccessVector that represents the vector of resource action pairs.
      • getStoreId

        public java.lang.Integer getStoreId()
        This method returns the Store ID set as input parameter for the Command.
        Specified by:
        getStoreId in interface ECCommand
        getStoreId in class AbstractECTargetableCommand
        An Integer that specifies the Store ID.
      • isReadyToCallExecute

        public boolean isReadyToCallExecute()
        This method is called by the Command Framework to check if all basic mandatory parameters have been set for this command. This is done before the Framework calls the performExecute method of the command.
        Specified by:
        isReadyToCallExecute in interface
        isReadyToCallExecute in class AbstractECTargetableCommand
        A boolean that is true if we can execute the command, and false otherwise.
      • reset

        public void reset()
        This method may be called after a command has been executed to reset its states variables. After the call to reset, we should be able to execute the command again.
        Specified by:
        reset in interface
        reset in class AbstractECTargetableCommand
      • setRequestProperties

        public void setRequestProperties(TypedProperty reqProperties)
                                  throws ECException
        The WebController calls the setRequestProperties method before invoking the execute method in this command. It is the responsibility of the implementation of the ControllerCommand to extract the required input parameters from the request properties and perform parameter checking.

        This method extracts the storeId parameters from the request properties.

        Specified by:
        setRequestProperties in interface ControllerCommand
        setRequestProperties in class ControllerCommandImpl
        reqProperties - The TypedProperty containing the request properties of the command.