com.ibm.commerce.contract.commands

Interface CreateLightWeightStoreCmd

  • 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 Subinterfaces:
    CreateLightWeightStoreWrapperCmd
    All Known Implementing Classes:
    CreateLightWeightStoreCmdImpl, CreateLightWeightStoreWrapperCmdImpl


    public interface CreateLightWeightStoreCmd
    extends com.ibm.commerce.command.TaskCommand
    This contract task command is used to create the light weight store based on the store XML. (WebSphere Commerce Enterprise only) The default implementation of this command is CreateLightWeightStoreCmdImpl. The CreateLightWeightStore URL is mapped to this command by default.
    • 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.contract.commands.CreateLightWeightStoreCmdImpl".
      static java.lang.String NAME
      The name of this interface is "com.ibm.commerce.contract.commands.CreateLightWeightStoreCmd".
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      java.lang.String[] getBusinessPolicyName()
      Gets the business policy names.
      java.lang.Integer getChannelStoreId()
      Gets the channel store ID.
      java.lang.Long getCreatedByContractId()
      Gets the contract's ID that creates the store.
      java.lang.Integer getDefaultShippingModeId()
      Gets the default shipping mode of the store.
      boolean getHasMasterCatalogProfileStore()
      Gets if master catalog exists in catalog profile store.
      java.util.Vector getPricePolicies()
      Gets price policies.
      java.lang.Long getProfileStoreCatalogId()
      Gets the catalog asset store's catalog ID.
      java.lang.String getProfileStoreCatalogName()
      Gets the catalog asset store's catalog name.
      java.lang.String getProfileStoreCatalogOwnerMemberId()
      Gets the catalog owner's member ID.
      boolean getResult()
      Gets if the store is successfully created.
      java.lang.String getStore_Id()
      Gets the store ID.
      java.lang.Integer getStoreDefaultLanguageId()
      Gets the store default language ID.
      org.w3c.dom.Element getStoreElement()
      Gets the Store element.
      java.lang.String getStoreIdentifier()
      Gets the store name/identifier.
      java.lang.String getStoreInitialState()
      Gets the store initial state.
      java.lang.String getStoreOwnerMemberId()
      Gets the store owner's member ID.
      java.lang.Integer getStoreType()
      Gets the store type.
      java.lang.String getStoreXML()
      Gets the store XML string.
      boolean getSynchronousDeployment()
      Gets the synchronousDeployment flag to indicate contract should be deployed synchronously.
      void setChannelStoreId(java.lang.Integer id)
      Sets the channel store ID.
      void setCreatedByContractId(java.lang.Long id)
      Sets the contract's ID that creates the store.
      void setStoreType(java.lang.Integer i)
      Sets the store type.
      void setStoreXML(java.lang.String storeXML)
      Sets the store XML string.
      void setSynchronousDeployment(boolean synchronousDeploymentFlag)
      Sets the synchronousDeployment flag to indicate contract should be deployed synchronously.
      • 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

      • 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.contract.commands.CreateLightWeightStoreCmdImpl".
        See Also:
        Constant Field Values
      • NAME

        static final java.lang.String NAME
        The name of this interface is "com.ibm.commerce.contract.commands.CreateLightWeightStoreCmd".
        See Also:
        Constant Field Values
    • Method Detail

      • getBusinessPolicyName

        java.lang.String[] getBusinessPolicyName()
        Gets the business policy names.
        Returns:
        Business policy names
      • getChannelStoreId

        java.lang.Integer getChannelStoreId()
        Gets the channel store ID.
        Returns:
        channel store ID
      • getCreatedByContractId

        java.lang.Long getCreatedByContractId()
        Gets the contract's ID that creates the store.
        Returns:
        the contract ID of the contract that creates the store
      • getDefaultShippingModeId

        java.lang.Integer getDefaultShippingModeId()
        Gets the default shipping mode of the store.
        Returns:
        Default shipping mode
      • getHasMasterCatalogProfileStore

        boolean getHasMasterCatalogProfileStore()
        Gets if master catalog exists in catalog profile store.
        Returns:
        true found master catalog in one of the specified catalog profile store
        false no master catalog was found in one of the specified catalog profile store, or there was no catalog profile store specified
      • getPricePolicies

        java.util.Vector getPricePolicies()
        Gets price policies.
        Returns:
        price policies
      • getProfileStoreCatalogId

        java.lang.Long getProfileStoreCatalogId()
        Gets the catalog asset store's catalog ID.
        Returns:
        catalog asset store's catalog ID
      • getProfileStoreCatalogName

        java.lang.String getProfileStoreCatalogName()
        Gets the catalog asset store's catalog name.
        Returns:
        catalog asset store's catalog name
      • getProfileStoreCatalogOwnerMemberId

        java.lang.String getProfileStoreCatalogOwnerMemberId()
        Gets the catalog owner's member ID.
        Returns:
        catalog owner's member ID
      • getResult

        boolean getResult()
        Gets if the store is successfully created.
        Returns:
        true: store is created successfully false: store is not created
      • getStore_Id

        java.lang.String getStore_Id()
        Gets the store ID.
        Returns:
        store ID
      • getStoreDefaultLanguageId

        java.lang.Integer getStoreDefaultLanguageId()
        Gets the store default language ID.
        Returns:
        store default language ID
      • getStoreElement

        org.w3c.dom.Element getStoreElement()
        Gets the Store element.
        Returns:
        Store element
      • getStoreIdentifier

        java.lang.String getStoreIdentifier()
        Gets the store name/identifier.
        Returns:
        Store name/identifier
      • getStoreInitialState

        java.lang.String getStoreInitialState()
        Gets the store initial state.
        Returns:
        store initial state
      • getStoreOwnerMemberId

        java.lang.String getStoreOwnerMemberId()
        Gets the store owner's member ID.
        Returns:
        store owner's member ID
      • getStoreType

        java.lang.Integer getStoreType()
        Gets the store type.
        Returns:
        0: distributor proxy store 1: reseller hosting store Only 0 and 1 will be returned.
      • getStoreXML

        java.lang.String getStoreXML()
        Gets the store XML string.
        Returns:
        Store XML string
      • getSynchronousDeployment

        boolean getSynchronousDeployment()
        Gets the synchronousDeployment flag to indicate contract should be deployed synchronously.
        Returns:
        true for synchronous deployment, false for asynchronous deployment
      • setChannelStoreId

        void setChannelStoreId(java.lang.Integer id)
        Sets the channel store ID.
        Parameters:
        id - channel store ID
      • setCreatedByContractId

        void setCreatedByContractId(java.lang.Long id)
        Sets the contract's ID that creates the store.
        Parameters:
        id - contract ID
      • setStoreType

        void setStoreType(java.lang.Integer i)
        Sets the store type.
        Parameters:
        i - 0: distributor proxy store 1: reseller hosting store Only 0 and 1 are allowed here.
      • setStoreXML

        void setStoreXML(java.lang.String storeXML)
        Sets the store XML string.
        Parameters:
        storeXML - store XML string
      • setSynchronousDeployment

        void setSynchronousDeployment(boolean synchronousDeploymentFlag)
        Sets the synchronousDeployment flag to indicate contract should be deployed synchronously.
        Parameters:
        synchronousDeploymentFlag - true for synchronous deployment, false for asynchronous deployment