com.ibm.commerce.contract.commands

Interface StoreCreationWizardCmd

  • All Superinterfaces:
    com.ibm.commerce.command.AccCommand, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.commerce.command.ControllerCommand, com.ibm.commerce.command.ECCommand, com.ibm.commerce.security.Protectable
    All Known Implementing Classes:
    StoreCreationWizardCmdImpl

    public interface StoreCreationWizardCmd
extends com.ibm.commerce.command.ControllerCommand
    This contract tools controller command is used to read the XML template file used by the Store Creation wizard, substituting default values. The default implementation of this command is StoreCreationWizardCmdImpl. The StoreCreationWizard URL is mapped to this command by default.

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      IBM copyright notice field.
      static java.lang.String defaultCommandClassName
      The default implementation class name of this interface.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      org.w3c.dom.Document createCustomXMLElement(org.w3c.dom.Document adocRoot)
      Override this method to customize the XML template read by the command.
      java.lang.String createHostedStoreHomepageURL()
      Override this method to define the hosted store home page URL.
      java.util.Vector getPaymentsList()
      Returns a Vector of hashtables of all payment listed (except for offline card and custom offline entries)

      • Methods inherited from class java.lang.Object

        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, isGeneric, isRetriable, mergeProperties, setGeneric, setRequestProperties, 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, performExecute, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

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

        fulfills, getOwner

    • Field Detail

      • COPYRIGHT

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

      • defaultCommandClassName

        static final java.lang.String defaultCommandClassName
        The default implementation class name of this interface.
        See Also:
        Constant Field Values

    • Method Detail

      • createCustomXMLElement

        org.w3c.dom.Document createCustomXMLElement(org.w3c.dom.Document adocRoot)
                                     throws com.ibm.commerce.exception.ECApplicationException
        Override this method to customize the XML template read by the command. This function is called before the XML object is passed to ContractImportApprovedVersionCmd.
        The current Document object of the XML is passed in as parameter. The method should return a Document object when the new XML elements are added.
        Parameters:
        adocRoot - The XML document root
        Returns:
        Document object after modifications
        Throws:
        com.ibm.commerce.exception.ECApplicationException - the exception to throw if the custom code needs to throw an exception

      • createHostedStoreHomepageURL

        java.lang.String createHostedStoreHomepageURL()
        Override this method to define the hosted store home page URL. Returns _HOSTED_STORE_HOMEPAGE_URL by default.
        Returns:
        The hosted store URL string

      • getPaymentsList

        java.util.Vector getPaymentsList()
        Returns a Vector of hashtables of all payment listed (except for offline card and custom offline entries)
        Returns:
        a Vector of hashtables of all payment listed
Skip navigation links