EmailOptOutCmdImpl

java.lang.Object
- MeasuredCacheableCommandImpl
- - com.ibm.commerce.command.AbstractECTargetableCommand
  - - com.ibm.commerce.command.ControllerCommandImpl
    - - com.ibm.commerce.emarketing.commands.EmailOptOutCmdImpl

All Implemented Interfaces:

AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, EmailOptOutCmd, Protectable, 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 EmailOptOutCmdImpl
extends ControllerCommandImpl
implements EmailOptOutCmd
```
The default implementation of EmailOptOutCmd.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String COPYRIGHT
Copyright.
- Fields inherited from class com.ibm.commerce.command.ControllerCommandImpl
  requestProperties, responseProperties, retriable, viewReqProperties
- Fields inherited from class com.ibm.commerce.command.AbstractECTargetableCommand
  commandContext
- Fields inherited from interface com.ibm.commerce.emarketing.commands.EmailOptOutCmd
  defaultCommandClassName
- Fields inherited from interface com.ibm.websphere.command.Command
  serialVersionUID

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COPYRIGHT` Copyright.

Constructor Summary

Constructors
Constructor and Description

EmailOptOutCmdImpl()

Constructors
Constructor and Description
`EmailOptOutCmdImpl()`

Method Summary

Methods
Modifier and Type	Method and Description
`TypedProperty`	`getResolvedRequestProperties()` Used to pass user traffic the input parameters received by the command
`AccessVector`	`getResources()` Gets the access vector accessed by this command.
`void`	`performExecute()` Contains the business logic for the command.
`void`	`validateParameters()` Validates the parameters expected in the request properties.

Methods inherited from class com.ibm.commerce.command.ControllerCommandImpl
checkPermission, fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResourceOwners, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setForUserId, setGeneric, setOwner, setRequestProperties, setResponseProperties, setRetriable, setViewInputProperties

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.ControllerCommand
checkPermission, execute, getGeneric, getRequestProperties, 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, 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, getStoreId, getUser, getUserId, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties

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
```
public static final java.lang.String COPYRIGHT
```
    Copyright.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - EmailOptOutCmdImpl
```
public EmailOptOutCmdImpl()
```
- Method Detail
  - getResources
```
public AccessVector getResources()
                          throws ECException
```
    Gets the access vector accessed by this command. The default implementation returns null indicating that no protectable resource is accessed by this command. It is the responsibilities of the command writer to return the protectable primary resource(s) and the corresponding actions accessed by this command.
    
    Specified by:
    
    getResources in interface ECCommand
    
    Overrides:
    
    getResources in class AbstractECTargetableCommand
    
    Returns:
    
    A vector of resource action pairs.
    
    Throws:
    
    ECException - If anything goes wrong with the resources being instantiated.
  - performExecute
```
public void performExecute()
                    throws ECException
```
    Contains the business logic for the command.
    
    Specified by:
    
    performExecute in interface ECCommand
    
    Specified by:
    
    performExecute in interface com.ibm.websphere.command.TargetableCommand
    
    Overrides:
    
    performExecute in class AbstractECTargetableCommand
    
    Throws:
    
    ECException - If anything goes wrong with the data resources being queried.
  - validateParameters
```
public void validateParameters()
                        throws ECException
```
    Validates the parameters expected in the request properties.
    
    Specified by:
    
    validateParameters in interface ECCommand
    
    Overrides:
    
    validateParameters in class AbstractECTargetableCommand
    
    Throws:
    
    ECException - If parameters are missing.
  - getResolvedRequestProperties
```
public TypedProperty getResolvedRequestProperties()
```
    Used to pass user traffic the input parameters received by the command
    
    Specified by:
    
    getResolvedRequestProperties in interface ControllerCommand
    
    Overrides:
    
    getResolvedRequestProperties in class ControllerCommandImpl
    
    Returns:
    
    the parameters the command resolved from the encrypted input

Class EmailOptOutCmdImpl

Field Summary

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

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

Fields inherited from interface com.ibm.commerce.emarketing.commands.EmailOptOutCmd

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

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.CommandCaller

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

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

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

Methods inherited from interface com.ibm.commerce.security.Protectable

Field Detail

COPYRIGHT

Constructor Detail

EmailOptOutCmdImpl

Method Detail

getResources

performExecute

validateParameters

getResolvedRequestProperties