PIRemoveCmd

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

All Superinterfaces:

AccCommand, AEDPCtrlCmd, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, ControllerCommand, ECCommand, Protectable, java.io.Serializable, com.ibm.websphere.command.TargetableCommand

All Known Implementing Classes:

PIRemoveCmdImpl, PIRemoveVoidCmdImpl
```
public interface PIRemoveCmd
extends AEDPCtrlCmd
```
This controller command is used to remove one or more existing payment instructions from an order. The default implementation of this command is PIEditCmdImpl.The PIRemove URL is mapped to this command by default.

See Also:

PIAddCmd, PICopyCmd, PIEditCmd

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COPYRIGHT` The IBM Copyright notice field.
`static java.lang.String`	`defaultCommandClassName` The default implementation class name is "com.ibm.commerce.edp.commands.PIRemoveCmdImpl".
`static java.lang.String`	`NAME` The interface name.
`static java.lang.String`	`PAYMENT_INSTRUCTION_ERROR_VIEW` The name of the error view to be displayed in case of a failure.

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

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`setPIIDs(java.lang.Long[] aPIIDs)` This method sets the list of IDs of payment instructions to be canceled.
`void`	`setURL(java.lang.String astrUrl)` This method sets the redirection URL to be called when the command completes successfully.

Methods inherited from interface com.ibm.commerce.edp.commands.AEDPCtrlCmd
getLocale, getOrderId, setOrderId

Methods inherited from interface com.ibm.commerce.command.ControllerCommand
checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRequestProperties, setRetriable, setViewInputProperties

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, performExecute, setCommandTarget, setCommandTargetName, setOutputProperties

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

Methods inherited from interface com.ibm.commerce.command.AccCommand
accessControlCheck, getAccCheck, getForUserId, getResourceOwners, setAccCheck, setForUserId, setOwner

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

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

Methods inherited from interface com.ibm.commerce.security.Protectable
fulfills, getOwner

- Field Detail
  - COPYRIGHT
```
static final java.lang.String COPYRIGHT
```
    The IBM Copyright notice field.
    
    See Also:
    
    Constant Field Values
  - NAME
```
static final java.lang.String NAME
```
    The interface name.
    
    See Also:
    
    Constant Field Values
  - defaultCommandClassName
```
static final java.lang.String defaultCommandClassName
```
    The default implementation class name is "com.ibm.commerce.edp.commands.PIRemoveCmdImpl".
    
    See Also:
    
    Constant Field Values
  - PAYMENT_INSTRUCTION_ERROR_VIEW
```
static final java.lang.String PAYMENT_INSTRUCTION_ERROR_VIEW
```
    The name of the error view to be displayed in case of a failure.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - setPIIDs
```
void setPIIDs(java.lang.Long[] aPIIDs)
```
    This method sets the list of IDs of payment instructions to be canceled.
    
    Parameters:
    
    aPIIDs - the list of payment instruction IDs to be canceled.
  - setURL
```
void setURL(java.lang.String astrUrl)
```
    This method sets the redirection URL to be called when the command completes successfully.
    
    Parameters:
    
    astrUrl - the redirection URL