com.ibm.commerce.interestitems.commands
Class InterestItemDisplayCmdImpl

com.ibm.commerce.command.AbstractECTargetableCommand
  |
  +--com.ibm.commerce.command.ControllerCommandImpl
        |
        +--com.ibm.commerce.interestitems.commands.InterestItemDisplayCmdImpl
All Implemented Interfaces:
AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, InterestItemDisplayCmd, Protectable

public class InterestItemDisplayCmdImpl
extends ControllerCommandImpl
implements InterestItemDisplayCmd

The InterestItemDisplay command displays a list or lists of all the products and items in the specified interest item lists. Note: Use this command in conjunction with SSL (Secure Sockets Layer), to ensure that the shopper's logon password and personal information are encrypted. SSL is the default.


Field Summary
static java.lang.String CLASSNAME
          The fully qualified name of this class.
static java.lang.String COPYRIGHT
          The internal copyright field.
 
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.interestitems.commands.InterestItemDisplayCmd
defaultCommandClassName, NAME
 
Constructor Summary
InterestItemDisplayCmdImpl()
          No value constructor.
 
Method Summary
 void checkIsAllowed(AccessVector resource, java.lang.String action)
          Check to see if user can perform action on resource.
 java.lang.Long[] getResourceOwners()
          Returns all the organization unit that owns the resources accessed by this command.It will return null if no resource is being accessed by this command.
 boolean isReadyToCallExecute()
          isReadyToCallExecute method is called by the Targettable Command frame work before the execution of the command.
 void performExecute()
          Contains the actual business logic of the command It should be implemented by all the command writer.
 void reset()
          This method should be called after a command has been executed to reset its states variables.
 void setListId(java.lang.String[] asaListId)
          Specifies zero or more interest item lists to be displayed.
 void setListIdName(java.lang.String[] asaListIdName)
          Specifies the names of name-value pairs to be added to the redirection URL.
 void setListMemberId(java.lang.Long anListMemberId)
          The id of the member whose interest lists will be displayed.
 void setRequestProperties(TypedProperty aRequestProperties)
          The WebController calls this method before invoking the execute method in this command to set the request properties for this command.
 void validateParameters()
          Performs server side parameter checking.
 
Methods inherited from class com.ibm.commerce.command.ControllerCommandImpl
fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setForUserId, setGeneric, setOwner, setResponseProperties, setRetriable, setViewInputProperties
 
Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand
accessControlCheck, checkIsAllowed, checkResourcePermission, execute, finalize, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, setAccCheck, setCommandContext, setCommandIfName, setDefaultProperties
 
Methods inherited from interface com.ibm.commerce.command.ControllerCommand
execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRetriable, setViewInputProperties
 
Methods inherited from interface com.ibm.commerce.command.AccCommand
accessControlCheck, getAccCheck, getForUserId, setAccCheck, setForUserId, setOwner
 
Methods inherited from interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, setCommandContext, setCommandIfName, setDefaultProperties
 
Methods inherited from interface com.ibm.commerce.security.Protectable
fulfills, getOwner
 

Field Detail

CLASSNAME

public static final java.lang.String CLASSNAME
The fully qualified name of this class.

COPYRIGHT

public static final java.lang.String COPYRIGHT
The internal copyright field.
Constructor Detail

InterestItemDisplayCmdImpl

public InterestItemDisplayCmdImpl()
No value constructor.
Method Detail

checkIsAllowed

public void checkIsAllowed(AccessVector resource,
                           java.lang.String action)
                    throws ECException
Check to see if user can perform action on resource. This is called by the command to perform resource level access control check in addition to the reources returned by the getResources() method.

Parameters:
resource - AccessVector - the resource to be acted on
action - String - action to be performed on the resource
Throws:
ECException -  

getResourceOwners

public java.lang.Long[] getResourceOwners()
                                   throws ECException
Description copied from interface: AccCommand
Returns all the organization unit that owns the resources accessed by this command.It will return null if no resource is being accessed by this command. This method was used in previous version for command level access control check. It is no longer required. It is kept for backward compatibility. The default implementation returns null.

Specified by:
getResourceOwners in interface AccCommand
Overrides:
getResourceOwners in class ControllerCommandImpl
Following copied from interface: com.ibm.commerce.command.AccCommand
Returns:
Long[] - an array of all organization unit reference numbers a site owner is representated by an organization unit value of -1

isReadyToCallExecute

public boolean isReadyToCallExecute()
Description copied from class: AbstractECTargetableCommand
isReadyToCallExecute method is called by the Targettable Command frame work before the execution of the command. The default implementation is to return true.

Overrides:
isReadyToCallExecute in class AbstractECTargetableCommand
Following copied from class: com.ibm.commerce.command.AbstractECTargetableCommand
Returns:
boolean - true if we can execute the command false if we canot execute the command

performExecute

public void performExecute()
                    throws ECException
Description copied from interface: ECCommand
Contains the actual business logic of the command It should be implemented by all the command writer.
Specified by:
performExecute in interface ECCommand
Overrides:
performExecute in class AbstractECTargetableCommand
Following copied from interface: com.ibm.commerce.command.ECCommand
Throws:
com.ibm.commerce.command.CommandException - The superclass for all ECExceptions.

reset

public void reset()
Description copied from class: AbstractECTargetableCommand
This method should 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

setListId

public void setListId(java.lang.String[] asaListId)
Specifies zero or more interest item lists to be displayed. In addition to interest item list reference numbers it can be specified as one of the special abbreviations ".", "*". If "." is specified, the GetCurrentIILists process task is invoked to obtain the shopper's current interest item lists, and the command behaves as if the current interest item lists were specified. If GetCurrentIILists process task determines that there are no current interest item lists, the most recently updated item interest item list is used. If "*" is specified, the command behaves as if all shopper's interest item lists were specified. If this parameter is missing, this command behaves as if "." were specified.
Specified by:
setListId in interface InterestItemDisplayCmd
Parameters:
asaListId - the ListId

setListIdName

public void setListIdName(java.lang.String[] asaListIdName)
Specifies the names of name-value pairs to be added to the redirection URL. The values of the added name-value pairs are the reference numbers of the interest lists specified by ListId. This is provided to make it possible to obtain the reference numbers of the interest lists when ListId is not explicitly specified.
Specified by:
setListIdName in interface InterestItemDisplayCmd
Parameters:
asaListIdName - the array of names

setListMemberId

public void setListMemberId(java.lang.Long anListMemberId)
The id of the member whose interest lists will be displayed. If this parameter is not specified, the default is the current member.
Specified by:
setListMemberId in interface InterestItemDisplayCmd
Parameters:
anListMemberId - the member id

setRequestProperties

public void setRequestProperties(TypedProperty aRequestProperties)
                          throws ECApplicationException
Description copied from interface: ControllerCommand
The WebController calls this method before invoking the execute method in this command to set the request properties for 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.
Specified by:
setRequestProperties in interface ControllerCommand
Overrides:
setRequestProperties in class ControllerCommandImpl
Following copied from interface: com.ibm.commerce.command.ControllerCommand
Parameters:
requestProperties - com.ibm.commerce.datatype.TypedProperty
Throws:
com.ibm.commerce.exception.ECException. -  

validateParameters

public void validateParameters()
                        throws ECException
Description copied from interface: ECCommand
Performs server side parameter checking. This method replaces the checkParameters() method in a previous version of the code.

Specified by:
validateParameters in interface ECCommand
Overrides:
validateParameters in class AbstractECTargetableCommand
Following copied from interface: com.ibm.commerce.command.ECCommand
Throws:
ECException. -