com.ibm.commerce.store.commands

Interface ManageStoreCmd

  • All Superinterfaces:
    com.ibm.websphere.command.CacheableCommand, com.ibm.commerce.command.CacheableECCommand, com.ibm.websphere.command.Command, com.ibm.commerce.command.ECCommand, com.ibm.commerce.command.TaskCommand
    All Known Implementing Classes:
    ManageStoreCmdImpl

    public interface ManageStoreCmd
extends com.ibm.commerce.command.TaskCommand
    This command manages the store state transition, whenever changing store state. Changing store states include: 1. Update store table status value, suspend -1, close 0 and open 1 2. Refresh store registry in memory 3. Invalidate WebSphere Application Server cache
      Mandatory parameters
    • storeEntityId - Store Entity Id

      Optional parameters
    • statusId - store state, Suspend -1, Close 0 and Open 1
    • markfordelete - markfordelete true

    If the ManageStoreCmd command takes storeEntityId and statusId(-1,0,1) as parameters, it will update store status to the new value, refresh store registry and invalidate WebSphere Application Server cache. If the ManageStoreCmd command takes storeEntityId and markfordelete(true) as parameter, it will mark store for delete, remove that store from store registry and invalidate WebSphere Application Server cache.

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      copyright notice
      static java.lang.String defaultCommandClassName
      name of the default implementation of this command
      static java.lang.String NAME
      name of this command

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      void setMarkforDelete(boolean markfordelete)
      Sets the message to be returned to the caller.
      void setStoreEntityId(java.lang.String storeId)
      Sets the store entity id.
      void setStoreStatus(java.lang.Integer statusId)
      Sets the store status.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

      • Methods inherited from interface com.ibm.commerce.command.CacheableECCommand

        execute

      • Methods inherited from interface com.ibm.commerce.command.ECCommand

        checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, performExecute, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

    • Field Detail

      • defaultCommandClassName

        static final java.lang.String defaultCommandClassName
        name of the default implementation of this command
        See Also:
        Constant Field Values

    • Method Detail

      • setMarkforDelete

        void setMarkforDelete(boolean markfordelete)
        Sets the message to be returned to the caller.
        Parameters:
        resultMsg - Message that is returned to the caller upon completion of the command

      • setStoreEntityId

        void setStoreEntityId(java.lang.String storeId)
        Sets the store entity id.
        Parameters:
        storeEntityId - The id of the store to be updated.

      • setStoreStatus

        void setStoreStatus(java.lang.Integer statusId)
        Sets the store status.
        Parameters:
        statusId - The id of the store state Suspend -1 Close 0 Open 1
Skip navigation links