public class StoreDataBean extends StoreAccessBean implements com.ibm.commerce.common.beans.StoreInputDataBean, com.ibm.commerce.common.beans.StoreSmartDataBean
Modifier and Type | Field and Description |
---|---|
static java.lang.String | COPYRIGHT
IBM copyright statement
|
static java.lang.String | URL_PATH_SEPARATOR
The URL separator
|
Constructor and Description |
---|
StoreDataBean()
This method is the constructor for the StoreDataBean.
|
StoreDataBean(StoreAccessBean abStore)
This method creates a StoreDataBean from a StoreAccessBean.
|
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.
|
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.
|
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, 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
|
CatalogAccessBean | getMasterCatalog()
This method gets the master catalog access bean for the store.
|
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).
|
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.
|
CatalogDataBean[] | getSalesCatalogs()
This method returns a list of beans that represents all the catalogs in the store that are sales catalogs (not master catalogs)
|
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.
|
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(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(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.
|
public static final java.lang.String COPYRIGHT
public static final java.lang.String URL_PATH_SEPARATOR
public StoreDataBean()
public StoreDataBean(StoreAccessBean abStore) throws java.rmi.RemoteException, javax.ejb.FinderException, javax.naming.NamingException, javax.ejb.CreateException
public CommandContext getCommandContext()
public java.lang.String getFilePath() throws java.lang.Exception
public java.lang.String getFilePath(java.lang.String filename) throws java.lang.Exception
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".
public java.lang.String getJspPath() throws java.lang.Exception
public java.lang.String getJspPath(java.lang.String filename) throws java.lang.Exception
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".
public java.lang.String getJspStoreDirFilePath() throws java.lang.Exception
The jspStoreDir request attribute value is used when building this path.
public java.util.ResourceBundle getResourceBundle(java.lang.String resourceName) throws ECException
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:
public java.util.ResourceBundle getResourceBundle(java.lang.String resourceName, java.lang.Integer languageId) throws ECException
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:
public java.lang.String getStorePartnerId()
public boolean isBuyerOrganizationRegisteredToStore(java.lang.String strBuyerOrgDN)
public boolean isBuyerOrganizationRegisteredToStore(java.lang.Long lBuyerOrgId)
public TypedProperty getRequestProperties()
public CatalogDataBean[] getStoreCatalogs() throws ECException
public CatalogDataBean[] getSalesCatalogs()
public CatalogDataBean getMasterCatalogDataBean()
public java.lang.String getStoreId()
public void populate() throws java.lang.Exception
public void setCommandContext(CommandContext aCommandContext)
public void setFilePath(java.lang.String filePath)
public void setJspPath(java.lang.String jspPath)
public void setJspStoreDir(java.lang.String storeDir)
public void setRequestProperties(TypedProperty requestProperty) throws ECException
public void setStoreId(java.lang.String storeId)
public void setStoreRelationshipTypeName(java.lang.String storeRelationshipTypeName)
public static java.lang.String getStoreContextPath() throws java.lang.Exception
public StoreEntityDescriptionAccessBean getDescription(java.lang.Integer aLanguageId) throws javax.ejb.CreateException, javax.ejb.FinderException, javax.naming.NamingException, java.rmi.RemoteException
public CatalogAccessBean getMasterCatalog() throws javax.ejb.FinderException, javax.naming.NamingException, java.rmi.RemoteException
public LanguageDataBean[] getLanguageDataBeans()
public CurrencyDataBean[] getCurrencyDataBeans()
public CurrencyData[] getStoreCurrencies()
public CurrencyData[] getStoreCurrencies(java.lang.Integer anLanguageId)
public StoreEntityDescriptionDataBean getStoreEntityDescriptionDataBean()
public java.lang.String getJspStoreDir()
public java.lang.String getApprovalToolLinkURL()
public java.lang.String getStoreDefaultCurrency()
public java.lang.Long getAllowedQuoteConfigExpiryPeriod()
public java.lang.Long getStoreDefaultQuoteConfigExpiryPeriod()
public boolean fulfills(java.lang.Long member, java.lang.String relationship) throws javax.ejb.FinderException, javax.naming.NamingException, java.rmi.RemoteException, java.lang.Exception
public java.lang.Long getOwner() throws javax.ejb.FinderException, javax.naming.NamingException, java.rmi.RemoteException, java.lang.Exception
public java.lang.Object getGroupingAttributeValue(java.lang.String attributeName, GroupingContext context) throws javax.ejb.FinderException, javax.naming.NamingException, java.rmi.RemoteException, java.lang.Exception
public java.lang.Integer[] getRelatedStoresByStoreRelationshipTypeName() throws javax.ejb.FinderException, javax.naming.NamingException, java.rmi.RemoteException, java.sql.SQLException
public java.lang.Integer[] getRelatedStores(java.lang.String storeRelationshipTypeName) throws javax.ejb.FinderException, javax.naming.NamingException, java.rmi.RemoteException, java.sql.SQLException
public StoreDefaultAccessBean getStoreDefault() throws javax.ejb.CreateException, javax.ejb.FinderException, javax.naming.NamingException, java.rmi.RemoteException
public java.lang.Integer[] getStoresForRelatedStoreByStoreRelationshipTypeName() throws javax.ejb.CreateException, javax.ejb.FinderException, javax.naming.NamingException, java.rmi.RemoteException, java.sql.SQLException
public java.lang.Integer[] getStoresForRelatedStore(java.lang.String storeRelationshipTypeName) throws javax.ejb.CreateException, javax.ejb.FinderException, javax.naming.NamingException, java.rmi.RemoteException, java.sql.SQLException
public java.lang.Integer[] getStorePathByStoreRelationshipTypeName() throws javax.ejb.CreateException, javax.ejb.FinderException, javax.naming.NamingException, java.rmi.RemoteException, java.sql.SQLException
public java.lang.Integer[] getStorePath(java.lang.String storeRelationshipTypeName) throws javax.ejb.CreateException, javax.ejb.FinderException, javax.naming.NamingException, java.rmi.RemoteException, java.sql.SQLException
public java.util.Enumeration getTaxCategory(java.lang.Integer taxType) throws javax.ejb.FinderException, javax.naming.NamingException, java.rmi.RemoteException