com.ibm.commerce.marketingcenter.events.runtime
Class ClickMonitorCommandImpl

java.lang.Object
  |
  +--CacheableCommandImpl
        |
        +--com.ibm.commerce.command.AbstractECTargetableCommand
              |
              +--com.ibm.commerce.command.ControllerCommandImpl
                    |
                    +--com.ibm.commerce.marketingcenter.events.runtime.ClickMonitorCommandImpl
All Implemented Interfaces:
AccCommand, ClickMonitorCommand, ControllerCommand, ECCommand, ECTargetableCommand

public class ClickMonitorCommandImpl
extends ControllerCommandImpl
implements ClickMonitorCommand

Controller command implementation to capture page-level click events.

See Also:
Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          IBM copyright notice field.
protected  java.lang.String urlParameter
          URL parameter to be used by the click monitor.
 
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.marketingcenter.events.runtime. ClickMonitorCommand
defaultCommandClassName
 
Constructor Summary
ClickMonitorCommandImpl()
          Constructs a ClickMonitorCommandImpl object.
 
Method Summary
 java.lang.String getUrl()
          Getter for urlParameter.
 boolean isGeneric()
          Check to see if this is a generic command.
 void performExecute()
          The business logic for this controller command.
 void setRequestProperties( TypedProperty reqProps)
          This method will call the super.setRequestProperties and then will set the URL parameter.
 void setUrl(java.lang.String aUrl)
          Setter for urlParameter.
 void validateParameters()
          The default implementation of validateParameters is just a no op.
 
Methods inherited from class com.ibm.commerce.command. ControllerCommandImpl
checkPermission, fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResolvedRequestProperties, getResourceOwners, getResponseProperties, getRetriable, getViewInputProperties, 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, getResources, getStoreId, getUser, getUserId, isReadyToCallExecute, reset, 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. ControllerCommand
checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isRetriable, mergeProperties, setGeneric, setRetriable, setViewInputProperties
 
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, getResources, getStoreId, getUser, getUserId, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties
 

Field Detail
public static final java.lang.String COPYRIGHT
IBM copyright notice field.
See Also:
Constant Field Values

urlParameter

protected java.lang.String urlParameter
URL parameter to be used by the click monitor.
Constructor Detail

ClickMonitorCommandImpl

public ClickMonitorCommandImpl()
Constructs a ClickMonitorCommandImpl object.
Method Detail

validateParameters

public void validateParameters()
                        throws ECException
The default implementation of validateParameters is just a no op. ControllerCommandImpl calls validateParameter in performExecute. It is the responsibility of the command writers to implements this method if they want to perform server side parameter checking. They should either calls validateParameters inside their performExecute or calls super() as the first line in their performExecute method.
Specified by:
validateParameters in interface ECCommand
Overrides:
validateParameters in class AbstractECTargetableCommand
Throws:
ECException
See Also:
ECCommand.validateParameters()

getUrl

public java.lang.String getUrl()
Getter for urlParameter.
Returns:
The URL parameter.

isGeneric

public boolean isGeneric()
Check to see if this is a generic command. A generic command can be called by a generic user. The default is false.
Specified by:
isGeneric in interface ControllerCommand
Overrides:
isGeneric in class ControllerCommandImpl
Returns:
true if this command can be called by a generic user; false otherwise.

performExecute

public void performExecute()
                    throws ECException
The business logic for this controller command. For this default implementation we simply calls checkParameters. Command writers who overwrites this method should do a super() as the first line in their method if they want checkParameters to be called.
Specified by:
performExecute in interface ECCommand
Overrides:
performExecute in class AbstractECTargetableCommand
Throws:
ECException
See Also:
ECCommand.performExecute()

setRequestProperties

public void setRequestProperties(TypedProperty reqProps)
                          throws ECException
This method will call the super.setRequestProperties and then will set the URL parameter.
Specified by:
setRequestProperties in interface ControllerCommand
Overrides:
setRequestProperties in class ControllerCommandImpl
Parameters:
reqProps - The request properties to be used.
Throws:
ECException - The exception description.

setUrl

public void setUrl(java.lang.String aUrl)
Setter for urlParameter.
Parameters:
aUrl - The url parameter to be used.