com.ibm.commerce.marketingcenter.events.runtime

Class ClickMonitorCommandImpl

  • java.lang.Object
    • com.ibm.websphere.command.CacheableCommandImpl
      • com.ibm.commerce.command.MeasuredCacheableCommandImpl
        • com.ibm.commerce.command.AbstractECTargetableCommand
          • com.ibm.commerce.command.ControllerCommandImpl
            • com.ibm.commerce.marketingcenter.events.runtime.ClickMonitorCommandImpl
  • All Implemented Interfaces:
    com.ibm.commerce.command.AccCommand, com.ibm.commerce.command.ControllerCommand, com.ibm.commerce.command.ECCommand, com.ibm.commerce.command.ECTargetableCommand, ClickMonitorCommand, com.ibm.commerce.security.Protectable, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command


    public class ClickMonitorCommandImpl
    extends com.ibm.commerce.command.ControllerCommandImpl
    implements ClickMonitorCommand
    Controller command implementation to capture page-level click events.
    • Constructor Summary

      Constructors 
      Constructor and Description
      ClickMonitorCommandImpl()
      Constructs a ClickMonitorCommandImpl object.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      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(com.ibm.commerce.datatype.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 java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • 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, checkResourcePermission, createCommandExecutionEvent, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getObjectSize, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, isReadyToCallExecute, reset, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties
      • 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, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties
      • Methods inherited from interface com.ibm.commerce.security.Protectable

        fulfills, getOwner
    • Field Detail

      • COPYRIGHT

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

      • ClickMonitorCommandImpl

        public ClickMonitorCommandImpl()
        Constructs a ClickMonitorCommandImpl object.
    • Method Detail

      • 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 com.ibm.commerce.command.ControllerCommand
        Overrides:
        isGeneric in class com.ibm.commerce.command.ControllerCommandImpl
        Returns:
        true if this command can be called by a generic user; false otherwise.
      • performExecute

        public void performExecute()
                            throws com.ibm.commerce.exception.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 com.ibm.commerce.command.ECCommand
        Overrides:
        performExecute in class com.ibm.commerce.command.AbstractECTargetableCommand
        Throws:
        com.ibm.commerce.exception.ECException
        See Also:
        ECCommand#performExecute()
      • setRequestProperties

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

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

        public void validateParameters()
                                throws com.ibm.commerce.exception.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 com.ibm.commerce.command.ECCommand
        Overrides:
        validateParameters in class com.ibm.commerce.command.AbstractECTargetableCommand
        Throws:
        com.ibm.commerce.exception.ECException
        See Also:
        ECCommand#validateParameters()