com.ibm.commerce.payment.commands
Class PaymentSummaryGenerateCmdImpl
java.lang.Object
CacheableCommandImpl
com.ibm.commerce.command.AbstractECTargetableCommand
com.ibm.commerce.command.ControllerCommandImpl
com.ibm.commerce.payment.commands.PaymentSummaryGenerateCmdImpl
- All Implemented Interfaces:
- AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, PaymentSummaryGenerateCmd, Protectable
- public class PaymentSummaryGenerateCmdImpl
- extends ControllerCommandImpl
- implements PaymentSummaryGenerateCmd
This PaymentSummaryGenerateCmdImpl Controller Command implementation 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.
This command uses the following AccessBeans:
This command calls the following TaskCommands:
- See Also:
- Serialized Form
Method Summary |
AccessVector |
getResources()
Gets the resources accessed by this command. |
java.lang.Integer |
getStoreId()
Gets the Store ID set as input parameter for the Command. |
boolean |
isReadyToCallExecute()
This method is called by the Command Framework to check if all basic mandatory parameters have been set for this command. |
void |
performExecute()
Performs the main business logic of the command. |
void |
reset()
This method may be called after a command has been executed to reset its states variables. |
void |
setRequestProperties(TypedProperty reqProperties)
The WebController calls the setRequestProperties method before invoking the execute method in this command. |
protected void |
setStoreId(java.lang.Integer anStoreId)
Sets the store ID for the command. |
void |
validateParameters()
Checks that the specified ID is a valid Store ID. |
Methods inherited from class com.ibm.commerce.command.ControllerCommandImpl |
checkPermission, fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResolvedRequestProperties, getResourceOwners, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setForUserId, setGeneric, setOwner, setResponseProperties, setRetriable, setViewInputProperties |
Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand |
accessControlCheck, checkIsAllowed, checkParameters, checkResourcePermission, createCommandExecutionEvent, execute, finalize, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getUser, getUserId, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties |
Methods inherited from class java.lang.Object |
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.ibm.commerce.command.ECCommand |
checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getUser, getUserId, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties |
Methods inherited from interface com.ibm.commerce.command.ControllerCommand |
checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRetriable, setViewInputProperties |
PaymentSummaryGenerateCmdImpl
public PaymentSummaryGenerateCmdImpl()
getResources
public AccessVector getResources()
throws ECException
- Gets 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
- Overrides:
- getResources in class AbstractECTargetableCommand
-
- Returns:
- AccessVector - a vector of resource action pairs
- Throws:
- ECException
getStoreId
public java.lang.Integer getStoreId()
- Gets the Store ID set as input parameter for the Command.
-
- Specified by:
- getStoreId in interface ECCommand
- Overrides:
- getStoreId in class AbstractECTargetableCommand
-
- Returns:
- 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.
-
- Overrides:
- isReadyToCallExecute in class AbstractECTargetableCommand
-
- Returns:
- true if we can execute the command; false otherwise.
performExecute
public void performExecute()
throws ECException
- Performs the main business logic of the command.
-
- Specified by:
- performExecute in interface ECCommand
- Overrides:
- performExecute in class AbstractECTargetableCommand
-
- Throws:
- ECException.
- ECException
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.
-
- Overrides:
- 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 implementer 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
- Overrides:
- setRequestProperties in class ControllerCommandImpl
-
- Throws:
- com.ibm.commerce.exception.ECApplicationException.
- ECException
setStoreId
protected void setStoreId(java.lang.Integer anStoreId)
- Sets the store ID for the command.
validateParameters
public void validateParameters()
throws ECException
- Checks that the specified ID is a valid Store ID.
-
- Specified by:
- validateParameters in interface ECCommand
- Overrides:
- validateParameters in class AbstractECTargetableCommand
-
- Throws:
- ECException.
- ECException
Feedback
(C) Copyright IBM Corporation 1996, 2005. All Rights Reserved.