com.ibm.commerce.common.beans

Class StoreDataBean

  • java.lang.Object
    • com.ibm.commerce.persistence.AbstractJpaEntityAccessBean
      • com.ibm.commerce.common.objects.StoreAccessBean
        • com.ibm.commerce.common.beans.StoreDataBean
  • All Implemented Interfaces:
    com.ibm.commerce.beans.DataBean, com.ibm.commerce.beans.InputDataBean, com.ibm.commerce.beans.SmartDataBean, StoreInputDataBean, StoreSmartDataBean, com.ibm.commerce.grouping.Groupable, com.ibm.commerce.security.Protectable, java.io.Serializable


    public class StoreDataBean
    extends com.ibm.commerce.common.objects.StoreAccessBean
    implements StoreInputDataBean, StoreSmartDataBean
    This data bean represents information from the STORE table. This table contains configuration and preferences information related to a store.
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      IBM copyright statement
      static java.lang.String URL_PATH_SEPARATOR
      The URL separator
      • Fields inherited from interface com.ibm.commerce.beans.DataBean

        emptyString
    • Constructor Summary

      Constructors 
      Constructor and Description
      StoreDataBean()
      This method is the constructor for the StoreDataBean.
      StoreDataBean(com.ibm.commerce.common.objects.StoreAccessBean abStore)
      This method creates a StoreDataBean from a StoreAccessBean.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      boolean fulfills(java.lang.Long member, java.lang.String relationship)
      Determines if a given member fulfills a given relationship with the resource.
      java.lang.Long getAllowedQuoteConfigExpiryPeriod()
      This method gets the allowed expiry period of quote that css or csr can set based on his/her role.
      java.lang.String getApprovalToolLinkURL()
      This method gets the ApprovalToolLinkURL.
      com.ibm.commerce.command.CommandContext getCommandContext()
      This method gets the command context set within this bean.
      CurrencyDataBean[] getCurrencyDataBeans()
      This method returns a list of beans that represent the currencies supported by this store.
      com.ibm.commerce.common.objects.StoreEntityDescriptionAccessBean getDescription(java.lang.Integer aLanguageId)
      This method gets the store description access bean for the specified language.
      java.lang.String getFilePath()
      This method returns the path that has to be prefixed to the front of a static assets for a store
      java.lang.String getFilePath(java.lang.String filename)
      This method returns the path that has to be prefixed to the front of a static assets for a store.
      java.lang.Object getGroupingAttributeValue(java.lang.String attributeName, com.ibm.commerce.grouping.GroupingContext context)
      Returns the value of a resource attribute - based on the attributeName and context.
      java.lang.String getJspPath()
      This method returns the path that has to be prefixed to the front of a store related JSP
      java.lang.String getJspPath(java.lang.String filename)
      This method returns the path that has to be prefixed to the front of a store related JSP.
      java.lang.String getJspStoreDir()
      This method returns the store directory in the request properties
      java.lang.String getJspStoreDirFilePath()
      This method returns the path that has to be prefixed to the front of a static assets for a store
      LanguageDataBean[] getLanguageDataBeans()
      This method returns a list of beans that represent the languages supported by this store
      com.ibm.commerce.catalog.objects.CatalogAccessBean getMasterCatalog()
      This method gets the master catalog access bean for the store.
      com.ibm.commerce.catalog.beans.CatalogDataBean getMasterCatalogDataBean()
      This method returns a databean that represents the master catalog of the store
      java.lang.Long getOwner()
      Returns the member id of the owner.
      java.lang.Integer[] getRelatedStores(java.lang.String storeRelationshipTypeName)
      Returns the stores related to this store by the given store relationship type.
      java.lang.Integer[] getRelatedStoresByStoreRelationshipTypeName()
      Returns the stores related to this store by the given store relationship type set by setStoreRelationshipTypeName(String).
      com.ibm.commerce.datatype.TypedProperty getRequestProperties()
      This method gets the request property set within this bean.
      java.util.ResourceBundle getResourceBundle(java.lang.String resourceName)
      This method gets a property resource bundle from a store directory.
      java.util.ResourceBundle getResourceBundle(java.lang.String resourceName, java.lang.Integer languageId)
      This method gets a property resource bundle from a store directory.
      com.ibm.commerce.catalog.beans.CatalogDataBean[] getSalesCatalogs()
      This method returns a list of beans that represents all the catalogs in the store that are sales catalogs (not master catalogs)
      com.ibm.commerce.catalog.beans.CatalogDataBean[] getStoreCatalogs()
      This method returns a list of beans that represents all the catalogs in the store
      static java.lang.String getStoreContextPath()
      This method returns the context path for the store servlet.
      CurrencyData[] getStoreCurrencies()
      This method returns a list of currencies descriptions for all the store's supported currencies.
      CurrencyData[] getStoreCurrencies(java.lang.Integer anLanguageId)
      This method returns a list of currencies descriptions for all the store's supported currencies.
      com.ibm.commerce.common.objects.StoreDefaultAccessBean getStoreDefault()
      Gets the StoreDefaultAccessBean object.
      java.lang.String getStoreDefaultCurrency()
      This method gets the default currency for this store.
      java.lang.Long getStoreDefaultQuoteConfigExpiryPeriod()
      This method gets the default expiry period of quote for the store.
      StoreEntityDescriptionDataBean getStoreEntityDescriptionDataBean()
      This method returns a bean representing the descriptive information about this store
      java.lang.String getStoreId()
      This method gets the store id that represents the primary key for this store
      java.lang.String getStorePartnerId()
      This method returns the partner organization Id that this store is under.
      java.lang.Integer[] getStorePath(java.lang.String storeRelationshipTypeName)
      Returns the stores related to this store by the given store relationship type.
      java.lang.Integer[] getStorePathByStoreRelationshipTypeName()
      Returns the stores related to this store by the store relationship type set by setStoreRelationshipTypeName(String).
      java.lang.Integer[] getStoresForRelatedStore(java.lang.String storeRelationshipTypeName)
      Returns the stores where this store is the related store by the given store relationship type.
      java.lang.Integer[] getStoresForRelatedStoreByStoreRelationshipTypeName()
      Returns the stores where this store is the related store by the store relationship type set by setStoreRelationshipTypeName(String).
      java.util.Enumeration getTaxCategory(java.lang.Integer taxType)
      Gets an enumeration of all tax category for a given tax type.
      boolean isBuyerOrganizationRegisteredToStore(java.lang.Long lBuyerOrgId)
      Given a buyer organization id, determine if this organization is registered to the store.
      boolean isBuyerOrganizationRegisteredToStore(java.lang.String strBuyerOrgDN)
      Given a buyer organization distinguished name, determine if this organization is registered to the store.
      void populate()
      This method loads the data for this bean.
      void setCommandContext(com.ibm.commerce.command.CommandContext aCommandContext)
      This method sets the command context within this bean.
      void setFilePath(java.lang.String filePath)
      This method sets the path for static resources
      void setJspPath(java.lang.String jspPath)
      This method sets the path for JSP pages.
      void setJspStoreDir(java.lang.String storeDir)
      This method sets the jsp store directory for JSP pages.
      void setRequestProperties(com.ibm.commerce.datatype.TypedProperty requestProperty)
      This method sets the request property within this bean.
      void setStoreId(java.lang.String storeId)
      This method sets the store ID that represents the primary key for this store
      void setStoreRelationshipTypeName(java.lang.String storeRelationshipTypeName)
      This method sets the store relationship type name of this data bean.
      • Methods inherited from class com.ibm.commerce.common.objects.StoreAccessBean

        fetchAssociatedObjects, findAll, findAllStores, findAllStoresByUserId, findByAdministrator, findByAdministratorAndMemberGroup, findByCatalog, findByCreatedByContract, findByDistinguishedName, findByDistinguishedNameNoCache, findByStatus, findByStatusNoCache, findByStoreCategory, findByStoreCategoryNoCache, findByStoreType, findByStoreTypeNoCache, findStoreByIdentifierAndCriteria, getAllocationGoodFor, getAllocationGoodForInEntityType, getAllocationOffset, getAvailableMaxPrecedenceOffers, getAvailableMaxPrecedenceOffers, getAvailableMaxPrecedenceOffers, getAvsAcceptCodes, getBlkExtAsynch, getBlockingActive, getBopmpadFactor, getBopmpadFactorInEntityType, getCatalogs, getCreatedByContract, getCurrency, getCurrency, getDefaultBoOffset, getDefaultBoOffsetInEntityType, getDefaultContractId, getDefaultContractIdInEntityType, getDefaultCurrency, getDescriptionNoCache, getDescriptionNoCache, getDirectory, getEntity, getField1, getField2, getFulfillmentCenter, getFulfillmentCenterId, getFulfillmentCenterIdInEntityType, getFulfillmentCenterSelectionFlags, getFulfillmentCenterSelectionFlagsInEntityType, getIdentifier, getInventoryOpFlags, getInventorySystem, getLanguageId, getLanguageIdInEntityType, getLastUpdateStatus, getMarkForDelete, getMaxBoOffset, getMaxBoOffsetInEntityType, getMaxFoOffset, getMemberId, getMemberIdInEntityType, getOID, getOrderHistoryActive, getPersistentSession, getPriceList, getPriceLists, getPriceRefFlags, getPriceRefFlagsInEntityType, getQuoteGoodFor, getQuoteGoodForInEntityType, getRejectedOrderExpiry, getRejectedOrderExpiryInEntityType, getReturnFFMCenterId, getReturnFFMCenterIdInEntityType, getRMAGoodFor, getRMAGoodForInEntityType, getStatus, getStatusInEntityType, getStoreCategoryId, getStoreCategoryIdInEntityType, getStoreEntityId, getStoreEntityIdInEntityType, getStoreGroup, getStoreGroupId, getStoreGroupIdInEntityType, getStoreLevel, getStoreType, getSupportedLanguageIds, getType, instantiateEntity, setAllocationGoodFor, setAllocationGoodFor, setAllocationOffset, setAvsAcceptCodes, setBlkExtAsynch, setBlockingActive, setBopmpadFactor, setBopmpadFactor, setCreatedByContract, setDefaultBoOffset, setDefaultBoOffset, setDefaultCurrency, setDirectory, setField1, setField2, setFulfillmentCenterId, setFulfillmentCenterId, setFulfillmentCenterSelectionFlags, setFulfillmentCenterSelectionFlags, setIdentifier, setInitKey_storeEntityId, setInitKey_storeEntityId, setInventoryOpFlags, setInventorySystem, setLanguageId, setLanguageId, setLastUpdateStatus, setMarkForDelete, setMaxBoOffset, setMaxBoOffset, setMaxFoOffset, setMemberId, setMemberId, setOID, setOrderHistoryActive, setPersistentSession, setPriceRefFlags, setPriceRefFlags, setQuoteGoodFor, setQuoteGoodFor, setRejectedOrderExpiry, setRejectedOrderExpiry, setReturnFFMCenterId, setReturnFFMCenterId, setRMAGoodFor, setRMAGoodFor, setStatus, setStatus, setStoreCategoryId, setStoreCategoryId, setStoreGroupId, setStoreGroupId, setStoreLevel, setStoreType
      • Methods inherited from class com.ibm.commerce.persistence.AbstractJpaEntityAccessBean

        createAccessBean, createAccessBean, createAccessBeanCollection, createAccessBeanCollection, createEntityCollection, detach, remove, setUseDataCache, toString
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Field Detail

      • COPYRIGHT

        public static final java.lang.String COPYRIGHT
        IBM copyright statement
        See Also:
        Constant Field Values
      • URL_PATH_SEPARATOR

        public static final java.lang.String URL_PATH_SEPARATOR
        The URL separator
        See Also:
        Constant Field Values
    • Constructor Detail

      • StoreDataBean

        public StoreDataBean()
        This method is the constructor for the StoreDataBean.
      • StoreDataBean

        public StoreDataBean(com.ibm.commerce.common.objects.StoreAccessBean abStore)
        This method creates a StoreDataBean from a StoreAccessBean.
        Parameters:
        abStore - com.ibm.commerce.common.objects.StoreAccessBean
    • Method Detail

      • fulfills

        public boolean fulfills(java.lang.Long member,
                                java.lang.String relationship)
                         throws java.lang.Exception
        Determines if a given member fulfills a given relationship with the resource. Overrides the StoreAccessBean implementation to avoid (re-)instantiating the EJB.
        Specified by:
        fulfills in interface com.ibm.commerce.security.Protectable
        Overrides:
        fulfills in class com.ibm.commerce.common.objects.StoreAccessBean
        Parameters:
        member - Member id of the member
        relationship - The relationship the member has with respect to the resource
        Returns:
        true if the member fulfills the relationship with the resource
        Throws:
        java.lang.Exception - Raised when there is an exception.
      • getAllowedQuoteConfigExpiryPeriod

        public java.lang.Long getAllowedQuoteConfigExpiryPeriod()
        This method gets the allowed expiry period of quote that css or csr can set based on his/her role. If the role has expiry date -1 or role is not CSR or CSS, then return default expiry date.
        Only special consideration for csr and css. For all other roles, we can use the default.
        Returns:
        maxExpiryPeriod quote expiry Period based on the role.
      • getApprovalToolLinkURL

        public java.lang.String getApprovalToolLinkURL()
        This method gets the ApprovalToolLinkURL. The bean does not need to be activated before this method can be used, however CommandContext has to be set by calling setCommandContext(CommandContext).
        Returns:
        java.lang.String
      • getCommandContext

        public com.ibm.commerce.command.CommandContext getCommandContext()
        This method gets the command context set within this bean.
        Specified by:
        getCommandContext in interface com.ibm.commerce.beans.SmartDataBean
        Returns:
        The command context set within this bean.
      • getCurrencyDataBeans

        public CurrencyDataBean[] getCurrencyDataBeans()
        This method returns a list of beans that represent the currencies supported by this store. Descriptions from this bean are site level descriptions and thus should not be used to display in a storefront.
        Returns:
        An array of CurrencyDataBean
      • getDescription

        public com.ibm.commerce.common.objects.StoreEntityDescriptionAccessBean getDescription(java.lang.Integer aLanguageId)
        This method gets the store description access bean for the specified language.
        Overrides:
        getDescription in class com.ibm.commerce.common.objects.StoreAccessBean
        Parameters:
        aLanguageId - The language id.
        Returns:
        the store description access bean for the specified language.
      • getFilePath

        public java.lang.String getFilePath()
                                     throws java.lang.Exception
        This method returns the path that has to be prefixed to the front of a static assets for a store
        Returns:
        The path for files
        Throws:
        java.lang.Exception - The java.lang.Exception
      • getFilePath

        public java.lang.String getFilePath(java.lang.String filename)
                                     throws java.lang.Exception
        This method returns the path that has to be prefixed to the front of a static assets for a store.

        If a file is added/removed/changed in a store directory, and the store has 'com.ibm.commerce.view' store relationships. Then the StoreRegistry for the corresponding store must be refreshed before retrieving the resource using this method.

        If an alias for the store is defined, this method will return the store alias followed by the store directory as the file path. If the alias is not defined, it will just return the store directory.

        If the store does not have any active 'com.ibm.commerce.view' store relationships, then this store's directory is used in the path. Otherwise, if the file exists in this store's public directory, then this store's directory is used in the path. Otherwise, the store directory in the request properties is used in the path.

        for example If the store alias is "storeAlias". And the store directory is "storeDir",. And this store has no 'com.ibm.commerce.view' store relationships. The result is "/storeAlias/storeDir/filename".

        for example If the store alias is "storeAlias". And the store directory is "storeDir". And this store has the 'com.ibm.commerce.view' store relationships. And the file does not exist in this store's directory. And the request properties has a ECConstants.EC_JSP_STORE_DIR parameter value "jspStoreDir". Then the result is "/storeAlias/jspStoreDir/filename".

        Parameters:
        filename - The name of the file
        Returns:
        The web path to the file
        Throws:
        java.lang.Exception - The java.lang.Exception exception
      • getGroupingAttributeValue

        public java.lang.Object getGroupingAttributeValue(java.lang.String attributeName,
                                                          com.ibm.commerce.grouping.GroupingContext context)
                                                   throws java.lang.Exception
        Returns the value of a resource attribute - based on the attributeName and context. Used by access control to determine if a resource falls within a resource group. Overrides the StoreAccessBean implementation to avoid (re-)instantiating the EJB.
        Specified by:
        getGroupingAttributeValue in interface com.ibm.commerce.grouping.Groupable
        Overrides:
        getGroupingAttributeValue in class com.ibm.commerce.common.objects.StoreAccessBean
        Parameters:
        attributeName - the attribute name.
        context - the grouping context.
        Returns:
        the value of the resource attribute.
        Throws:
        java.lang.Exception - Raised when there is an exception.
      • getJspPath

        public java.lang.String getJspPath()
        This method returns the path that has to be prefixed to the front of a store related JSP
        Returns:
        The path for JSPs
        Throws:
        java.lang.Exception - The java.lang.Exception exception
      • getJspPath

        public java.lang.String getJspPath(java.lang.String filename)
                                    throws java.lang.Exception
        This method returns the path that has to be prefixed to the front of a store related JSP.

        If a JSP is added, removed, or changed in a store directory, and the store has com.ibm.commerce.view store relationships, then the StoreRegistry for the corresponding store must be refreshed before retrieving the resource using this method.

        If the store does not have any active com.ibm.commerce.view store relationships, then this store's directory is used in the path. Otherwise, if the file exists in this store's public directory, then this store's directory is used in the path. Otherwise, the store directory in the request properties is used in the path.

        For example,
        If the store directory is storeDir. And this store has no com.ibm.commerce.view store relationships. The result is "/storeDir/filename".

        For example,
        If the store directory is storeDir. And this store has the com.ibm.commerce.view store relationships. And the file does not exist in this store's directory. And the request properties has a ECConstants.EC_JSP_STORE_DIR parameter value "jspStoreDir". Then the result is "/jspStoreDir/filename".

        Parameters:
        filename - the name of the JSP
        Returns:
        the path to the JSP
        Throws:
        java.lang.Exception - Raised when there is an exception.
      • getJspStoreDir

        public java.lang.String getJspStoreDir()
        This method returns the store directory in the request properties
        Returns:
        java.lang.String
      • getJspStoreDirFilePath

        public java.lang.String getJspStoreDirFilePath()
                                                throws java.lang.Exception
        This method returns the path that has to be prefixed to the front of a static assets for a store

        The jspStoreDir request attribute value is used when building this path.

        Returns:
        A store directory
        Throws:
        java.lang.Exception - The java.lang.Exception exception
      • getLanguageDataBeans

        public LanguageDataBean[] getLanguageDataBeans()
        This method returns a list of beans that represent the languages supported by this store
        Returns:
        An array of LanguageDataBean
      • getMasterCatalog

        public com.ibm.commerce.catalog.objects.CatalogAccessBean getMasterCatalog()
                                                                            throws javax.naming.NamingException
        This method gets the master catalog access bean for the store.
        Overrides:
        getMasterCatalog in class com.ibm.commerce.common.objects.StoreAccessBean
        Returns:
        the master catalog access bean for the store.
        Throws:
        javax.naming.NamingException - Raised when there is an exception looking up the name of the bean.
      • getMasterCatalogDataBean

        public com.ibm.commerce.catalog.beans.CatalogDataBean getMasterCatalogDataBean()
        This method returns a databean that represents the master catalog of the store
        Returns:
        CatalogDataBeans
      • getOwner

        public java.lang.Long getOwner()
                                throws java.lang.Exception
        Returns the member id of the owner. Overrides the StoreAccessBean implementation to avoid (re-)instantiating the EJB.
        Specified by:
        getOwner in interface com.ibm.commerce.security.Protectable
        Overrides:
        getOwner in class com.ibm.commerce.common.objects.StoreAccessBean
        Returns:
        The member id of the owner
        Throws:
        java.lang.Exception - Raised when there is an exception.
      • getRelatedStores

        public java.lang.Integer[] getRelatedStores(java.lang.String storeRelationshipTypeName)
                                             throws javax.naming.NamingException,
                                                    java.sql.SQLException
        Returns the stores related to this store by the given store relationship type. The related store ids are sorted in ascending order of the store relationship sequence.
        Overrides:
        getRelatedStores in class com.ibm.commerce.common.objects.StoreAccessBean
        Parameters:
        storeRelationshipTypeName - the store relationship type name
        Returns:
        an Integer array of store ids
        Throws:
        javax.naming.NamingException - Raised when there is an exception looking up the name of the bean.
        java.sql.SQLException - Raised when there is an exception.
      • getRelatedStoresByStoreRelationshipTypeName

        public java.lang.Integer[] getRelatedStoresByStoreRelationshipTypeName()
                                                                        throws javax.naming.NamingException,
                                                                               java.sql.SQLException
        Returns the stores related to this store by the given store relationship type set by setStoreRelationshipTypeName(String). The related store ids are sorted in ascending order of the store relationship sequence.
        Parameters:
        storeRelationshipTypeName - the store relationship type name
        Returns:
        an Integer array of store ids
        Throws:
        javax.naming.NamingException - Raised when there is an exception looking up the name of the bean.
        java.sql.SQLException - Raised when there is an exception.
        See Also:
        #getRelatedStores(String)}, #setStoreRelationshipTypeName(String)}
      • getRequestProperties

        public com.ibm.commerce.datatype.TypedProperty getRequestProperties()
        This method gets the request property set within this bean.
        Specified by:
        getRequestProperties in interface com.ibm.commerce.beans.InputDataBean
        Returns:
        The request property set within this bean.
      • getResourceBundle

        public java.util.ResourceBundle getResourceBundle(java.lang.String resourceName)
                                                   throws com.ibm.commerce.exception.ECException
        This method gets a property resource bundle from a store directory.

        If a properties file is added, removed, or changed in a store directory, then the StoreRegistry for the corresponding store must be refreshed before retrieving the resource using this method.

        The store path for the com.ibm.commerce.view relationship type is used as the basis for the search of the resource.

        For each store, the search consists of searching for .properties files with the locale as set in the command context. If a file with the command context locale cannot be found, then a file with no locale is searched for.

        eg. The command context locale is en_US, and there are two stores in the store path with directories storeA and storeB. The search order is:

        1. storeA/resourceName_en_US.properties
        2. storeA/resourceName.properties
        3. storeB/resourceName_en_US.properties
        4. storeB/resourceName.properties
        Parameters:
        resourceName - The name of the resource, using '.' as the namespace delimiter
        Returns:
        A resource bundle
        Throws:
        com.ibm.commerce.exception.ECException - The com.ibm.comerce.exception.ECException exception
      • getResourceBundle

        public java.util.ResourceBundle getResourceBundle(java.lang.String resourceName,
                                                          java.lang.Integer languageId)
                                                   throws com.ibm.commerce.exception.ECException
        This method gets a property resource bundle from a store directory.

        If a properties file is added, removed, or changed in a store directory, then the StoreRegistry for the corresponding store must be refreshed before retrieving the resource using this method.

        The store path for the com.ibm.commerce.view relationship type is used as the basis for the search of the resource.

        For each store, the search consists of searching for .properties files with the locale as set in the command context. If a file with the locale of the specified language cannot be found, then a file with no locale is searched for.

        For example: The locale for the specified language id is en_US, and there are two stores in the store path with directories storeA and storeB. The search order is:

        1. storeA/resourceName_en_US.properties
        2. storeA/resourceName.properties
        3. storeB/resourceName_en_US.properties
        4. storeB/resourceName.properties
        Parameters:
        resourceName - The name of the resource, using '.' as the namespace delimiter
        languageId - The language ID
        Returns:
        A resource bundle
        Throws:
        com.ibm.commerce.exception.ECException - The com.ibm.commerce.exception.ECException exception
      • getSalesCatalogs

        public com.ibm.commerce.catalog.beans.CatalogDataBean[] getSalesCatalogs()
        This method returns a list of beans that represents all the catalogs in the store that are sales catalogs (not master catalogs)
        Returns:
        An array of CatalogDataBeans
      • getStoreCatalogs

        public com.ibm.commerce.catalog.beans.CatalogDataBean[] getStoreCatalogs()
                                                                          throws com.ibm.commerce.exception.ECException
        This method returns a list of beans that represents all the catalogs in the store
        Specified by:
        getStoreCatalogs in interface StoreSmartDataBean
        Returns:
        An array of CatalogDataBeans
        Throws:
        com.ibm.commerce.exception.ECException - The com.ibm.commerce.exception.ECException
      • getStoreContextPath

        public static java.lang.String getStoreContextPath()
                                                    throws java.lang.Exception
        This method returns the context path for the store servlet.
        Returns:
        The context path for store servlet.
        Throws:
        java.lang.Exception - The java.lang.Exception
      • getStoreCurrencies

        public CurrencyData[] getStoreCurrencies()
        This method returns a list of currencies descriptions for all the store's supported currencies.
        Returns:
        An array of currencies descriptions from CURFMTDESC.DESCRIPTION for all the store's supported currencies.
      • getStoreCurrencies

        public CurrencyData[] getStoreCurrencies(java.lang.Integer anLanguageId)
        This method returns a list of currencies descriptions for all the store's supported currencies.
        Parameters:
        anLanguageId - the language for the descriptions. Specify null for the languageId returned by getCommandContext().getLanguageId().
        Returns:
        An array of currencies descriptions from CURFMTDESC.DESCRIPTION for all the store's supported currencies.
      • getStoreDefault

        public com.ibm.commerce.common.objects.StoreDefaultAccessBean getStoreDefault()
        Gets the StoreDefaultAccessBean object.
        Overrides:
        getStoreDefault in class com.ibm.commerce.common.objects.StoreAccessBean
        Returns:
        a StoreDefaultAccessBean for this store
      • getStoreDefaultCurrency

        public java.lang.String getStoreDefaultCurrency()
        This method gets the default currency for this store. If there is a store entity level default currency, it will take precedence.
        Returns:
        the default currency.
      • getStoreDefaultQuoteConfigExpiryPeriod

        public java.lang.Long getStoreDefaultQuoteConfigExpiryPeriod()
        This method gets the default expiry period of quote for the store. If no configuration for the target store, store group -1 will be used.
        Returns:
        defaultQuoteConfigExpiryPeriod store default quote expiry Period
      • getStoreEntityDescriptionDataBean

        public StoreEntityDescriptionDataBean getStoreEntityDescriptionDataBean()
        This method returns a bean representing the descriptive information about this store
        Returns:
        The StoreEntityDescriptionDataBean
      • getStoreId

        public java.lang.String getStoreId()
        This method gets the store id that represents the primary key for this store
        Specified by:
        getStoreId in interface StoreSmartDataBean
        Returns:
        The store id.
      • getStorePartnerId

        public java.lang.String getStorePartnerId()
        This method returns the partner organization Id that this store is under.
        Returns:
        The partner organization Id that this store is under.
      • getStorePath

        public java.lang.Integer[] getStorePath(java.lang.String storeRelationshipTypeName)
                                         throws javax.naming.NamingException,
                                                java.sql.SQLException
        Returns the stores related to this store by the given store relationship type. The related store ids are sorted in ascending order of the store relationship sequence. When there are no related stores, this store's id is returned. This method returns the same value as getRelatedStores, with the additional semantic that if there are no related stores, this store's id is returned.
        Overrides:
        getStorePath in class com.ibm.commerce.common.objects.StoreAccessBean
        Parameters:
        storeRelationshipTypeName - the store relationship type name
        Returns:
        an Integer array of store ids
        Throws:
        javax.naming.NamingException - Raised when there is an exception looking up the name of the bean.
        java.sql.SQLException - Raised when there is an exception with the database.
      • getStorePathByStoreRelationshipTypeName

        public java.lang.Integer[] getStorePathByStoreRelationshipTypeName()
                                                                    throws javax.naming.NamingException,
                                                                           java.sql.SQLException
        Returns the stores related to this store by the store relationship type set by setStoreRelationshipTypeName(String). The related store ids are sorted in ascending order of the store relationship sequence. When there are no related stores, this store's id is returned. This method returns the same value as getRelatedStores, with the additional semantic that if there are no related stores, this store's id is returned.
        Returns:
        an Integer array of store ids
        Throws:
        javax.naming.NamingException - Raised when there is an exception looking up the name of the bean.
        java.sql.SQLException - Raised when there is an exception with the database.
        See Also:
        #getStorePath(String)}, #setStoreRelationshipTypeName(String)}
      • getStoresForRelatedStore

        public java.lang.Integer[] getStoresForRelatedStore(java.lang.String storeRelationshipTypeName)
                                                     throws javax.naming.NamingException,
                                                            java.sql.SQLException
        Returns the stores where this store is the related store by the given store relationship type. The related store ids are sorted in ascending order of the store relationship sequence.
        Overrides:
        getStoresForRelatedStore in class com.ibm.commerce.common.objects.StoreAccessBean
        Parameters:
        storeRelationshipTypeName - the store relationship type name
        Returns:
        an Integer array of store ids
        Throws:
        javax.naming.NamingException - Raised when there is an exception looking up the name of the bean.
        java.sql.SQLException - Raised when there is an exception with the database.
      • getStoresForRelatedStoreByStoreRelationshipTypeName

        public java.lang.Integer[] getStoresForRelatedStoreByStoreRelationshipTypeName()
                                                                                throws javax.naming.NamingException,
                                                                                       java.sql.SQLException
        Returns the stores where this store is the related store by the store relationship type set by setStoreRelationshipTypeName(String). The related store ids are sorted in ascending order of the store relationship sequence.
        Parameters:
        storeRelationshipTypeName - the store relationship type name
        Returns:
        an Integer array of store ids
        Throws:
        javax.naming.NamingException - Raised when there is an exception looking up the name of the bean.
        java.sql.SQLException - Raised when there is an exception with the database.
        See Also:
        #getStoresForRelatedStore(String)}, #setStoreRelationshipTypeName(String)}
      • getTaxCategory

        public java.util.Enumeration getTaxCategory(java.lang.Integer taxType)
        Gets an enumeration of all tax category for a given tax type.

        Overrides:
        getTaxCategory in class com.ibm.commerce.common.objects.StoreAccessBean
        Parameters:
        taxType - tax type
        Returns:
        an enumeration of tax catagory
      • isBuyerOrganizationRegisteredToStore

        public boolean isBuyerOrganizationRegisteredToStore(java.lang.Long lBuyerOrgId)
        Given a buyer organization id, determine if this organization is registered to the store.
        Parameters:
        lBuyerOrgId - The memberId of a buyer organization.
        Returns:
        true if the buyer organization is registered to the store; false otherwise
      • isBuyerOrganizationRegisteredToStore

        public boolean isBuyerOrganizationRegisteredToStore(java.lang.String strBuyerOrgDN)
        Given a buyer organization distinguished name, determine if this organization is registered to the store.
        Parameters:
        strBuyerOrgDN - The distinguished name of a buyer organization
        Returns:
        true if the buyer organization is registered to the store; false otherwise
      • populate

        public void populate()
                      throws java.lang.Exception
        This method loads the data for this bean. Retrieve the information from the STORE table. Loads data into the data bean when the DataBeanManager.activate() executes.
        Specified by:
        populate in interface com.ibm.commerce.beans.SmartDataBean
        Throws:
        java.lang.Exception - The java.lang.Exception exception.
      • setCommandContext

        public void setCommandContext(com.ibm.commerce.command.CommandContext aCommandContext)
        This method sets the command context within this bean.
        Specified by:
        setCommandContext in interface com.ibm.commerce.beans.SmartDataBean
        Parameters:
        aCommandContext - The command context to set within this bean.
      • setFilePath

        public void setFilePath(java.lang.String filePath)
        This method sets the path for static resources
        Parameters:
        filePath - The file path
      • setJspPath

        public void setJspPath(java.lang.String jspPath)
        This method sets the path for JSP pages.
        Parameters:
        jspPath - The JSP path
      • setJspStoreDir

        public void setJspStoreDir(java.lang.String storeDir)
        This method sets the jsp store directory for JSP pages.
        Parameters:
        storeDir - The JSP store directory.
      • setRequestProperties

        public void setRequestProperties(com.ibm.commerce.datatype.TypedProperty requestProperty)
        This method sets the request property within this bean.
        Specified by:
        setRequestProperties in interface com.ibm.commerce.beans.InputDataBean
        Parameters:
        requestProperty - The request property to set within this bean.
        Throws:
        com.ibm.commerce.exception.ECException - The ECException exception.
      • setStoreId

        public void setStoreId(java.lang.String storeId)
        This method sets the store ID that represents the primary key for this store
        Specified by:
        setStoreId in interface StoreInputDataBean
        Parameters:
        storeId - The store ID
      • setStoreRelationshipTypeName

        public void setStoreRelationshipTypeName(java.lang.String storeRelationshipTypeName)
        This method sets the store relationship type name of this data bean. The default value, "com.ibm.commerce.propertyFiles", will be used for methods that do not require the store relationship type.
        Parameters:
        storeRelationshipTypeName - The store relationship type name.