com.ibm.commerce.store.commands

Interface StoreCloseCmd

  • 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:
    StoreCloseCmdImpl

    public interface StoreCloseCmd
extends com.ibm.commerce.command.ControllerCommand
    Changes the state of the store to closed. StoreCloseCmd accepts the following parameters from the User Interface:
      Mandatory parameters
    • URL - URL that is executed upon completion of the command
    • targetStoreId - string of target store id

    This command takes target store id String and then iteratively calls the ManageStoreTaskCmd task command to update store state to close, refresh store registry and invalidate WebSphere Application Server cache.

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      The internal copyright field.
      static java.lang.String defaultCommandClassName
      The default implementation class is "com.ibm.commerce.store.commands.StoreCloseCmdImpl".
      static java.lang.String NAME
      The name of this interface is "com.ibm.commerce.store.commands.StoreCloseCmd".

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      void setTargetStoreId(java.lang.Long[] newTargetStoreId)
      Sets the list of targetStoreId to Opened.
      void setURL(java.lang.String newUrl)
      Sets the URL to be redirected to when the command completes successfully.

      • 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
        The internal copyright field.
        See Also:
        Constant Field Values

      • defaultCommandClassName

        static final java.lang.String defaultCommandClassName
        The default implementation class is "com.ibm.commerce.store.commands.StoreCloseCmdImpl".
        See Also:
        Constant Field Values

      • NAME

        static final java.lang.String NAME
        The name of this interface is "com.ibm.commerce.store.commands.StoreCloseCmd".
        See Also:
        Constant Field Values

    • Method Detail

      • setTargetStoreId

        void setTargetStoreId(java.lang.Long[] newTargetStoreId)
        Sets the list of targetStoreId to Opened. Store Id list
        Parameters:
        the - array of store id Long type

      • setURL

        void setURL(java.lang.String newUrl)
        Sets the URL to be redirected to when the command completes successfully.
        Parameters:
        the - URL string to be redirected
Skip navigation links