com.ibm.commerce.interestitems.commands

Class InterestItemDisplayCmdImpl

  • All Implemented Interfaces:
    AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, InterestItemDisplayCmd, Protectable, com.ibm.websphere.cache.Sizeable, 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 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.
    See Also:
    Serialized Form
    • Field Detail

      • COPYRIGHT

        public static final java.lang.String COPYRIGHT
        The internal copyright field.
        See Also:
        Constant Field Values
      • CLASSNAME

        public static final java.lang.String CLASSNAME
        The fully qualified name of this class.
        See Also:
        Constant Field Values
    • 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 resources 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 class: ControllerCommandImpl
        This method gets all the organization units that own the resources accessed by this command. It returns null if no resource is being accessed by this command. This method was used in WebSphere Commerce 5.1 for command level access control checking. 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
        Returns:
        This method returns an array of Long objects that represents all the organization unit reference numbers. A site owner is represented by an organization unit value of -1.
        Throws:
        ECException
      • isReadyToCallExecute

        public boolean isReadyToCallExecute()
        Description copied from class: AbstractECTargetableCommand
        This method is called by the targetable command framework. This is where client side parameter checking is performed (before the execution of the command). The default implementation is to return true.
        Specified by:
        isReadyToCallExecute in interface com.ibm.websphere.command.Command
        Overrides:
        isReadyToCallExecute in class AbstractECTargetableCommand
        Returns:
        This method returns a boolean value; true if we can execute the command and false otherwise. This default implementation will return true.
      • reset

        public void reset()
        Description copied from class: AbstractECTargetableCommand
        This method is called after a command has been executed. It is used to reset its states variables. After the call to reset, the command should be able to be executed again.
        Specified by:
        reset in interface com.ibm.websphere.command.Command
        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 ".", "*". Sets the interest item list ID parameters (optional with default "."). 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