public class StoreDataBean extends com.ibm.commerce.common.objects.StoreAccessBean implements StoreInputDataBean, 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(com.ibm.commerce.common.objects.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.
|
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.
|
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
public static final java.lang.String COPYRIGHT
public static final java.lang.String URL_PATH_SEPARATOR
public StoreDataBean()
public StoreDataBean(com.ibm.commerce.common.objects.StoreAccessBean abStore)
abStore
- com.ibm.commerce.common.objects.StoreAccessBeanpublic boolean fulfills(java.lang.Long member, java.lang.String relationship) throws java.lang.Exception
fulfills
in interface com.ibm.commerce.security.Protectable
fulfills
in class com.ibm.commerce.common.objects.StoreAccessBean
member
- Member id of the memberrelationship
- The relationship the member has with respect to the resourcejava.lang.Exception
- Raised when there is an exception.public java.lang.Long getAllowedQuoteConfigExpiryPeriod()
public java.lang.String getApprovalToolLinkURL()
public com.ibm.commerce.command.CommandContext getCommandContext()
getCommandContext
in interface com.ibm.commerce.beans.SmartDataBean
public CurrencyDataBean[] getCurrencyDataBeans()
public com.ibm.commerce.common.objects.StoreEntityDescriptionAccessBean getDescription(java.lang.Integer aLanguageId)
getDescription
in class com.ibm.commerce.common.objects.StoreAccessBean
aLanguageId
- The language id.public java.lang.String getFilePath() throws java.lang.Exception
java.lang.Exception
- The java.lang.Exceptionpublic 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".
filename
- The name of the filejava.lang.Exception
- The java.lang.Exception exceptionpublic java.lang.Object getGroupingAttributeValue(java.lang.String attributeName, com.ibm.commerce.grouping.GroupingContext context) throws java.lang.Exception
getGroupingAttributeValue
in interface com.ibm.commerce.grouping.Groupable
getGroupingAttributeValue
in class com.ibm.commerce.common.objects.StoreAccessBean
attributeName
- the attribute name.context
- the grouping context.java.lang.Exception
- Raised when there is an exception.public java.lang.String getJspPath()
java.lang.Exception
- The java.lang.Exception exceptionpublic 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".
filename
- the name of the JSPjava.lang.Exception
- Raised when there is an exception.public java.lang.String getJspStoreDir()
public java.lang.String getJspStoreDirFilePath() throws java.lang.Exception
The jspStoreDir request attribute value is used when building this path.
java.lang.Exception
- The java.lang.Exception exceptionpublic LanguageDataBean[] getLanguageDataBeans()
public com.ibm.commerce.catalog.objects.CatalogAccessBean getMasterCatalog() throws javax.naming.NamingException
getMasterCatalog
in class com.ibm.commerce.common.objects.StoreAccessBean
javax.naming.NamingException
- Raised when there is an exception looking up the name of the bean.public com.ibm.commerce.catalog.beans.CatalogDataBean getMasterCatalogDataBean()
public java.lang.Long getOwner() throws java.lang.Exception
getOwner
in interface com.ibm.commerce.security.Protectable
getOwner
in class com.ibm.commerce.common.objects.StoreAccessBean
java.lang.Exception
- Raised when there is an exception.public java.lang.Integer[] getRelatedStores(java.lang.String storeRelationshipTypeName) throws javax.naming.NamingException, java.sql.SQLException
getRelatedStores
in class com.ibm.commerce.common.objects.StoreAccessBean
storeRelationshipTypeName
- the store relationship type namejavax.naming.NamingException
- Raised when there is an exception looking up the name of the bean.java.sql.SQLException
- Raised when there is an exception.public java.lang.Integer[] getRelatedStoresByStoreRelationshipTypeName() throws javax.naming.NamingException, java.sql.SQLException
setStoreRelationshipTypeName(String)
.
The related store ids are sorted in ascending order of the store relationship sequence.storeRelationshipTypeName
- the store relationship type namejavax.naming.NamingException
- Raised when there is an exception looking up the name of the bean.java.sql.SQLException
- Raised when there is an exception.#getRelatedStores(String)}
,
#setStoreRelationshipTypeName(String)}
public com.ibm.commerce.datatype.TypedProperty getRequestProperties()
getRequestProperties
in interface com.ibm.commerce.beans.InputDataBean
public java.util.ResourceBundle getResourceBundle(java.lang.String resourceName) throws com.ibm.commerce.exception.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:
resourceName
- The name of the resource, using '.' as the namespace delimitercom.ibm.commerce.exception.ECException
- The com.ibm.comerce.exception.ECException exceptionpublic java.util.ResourceBundle getResourceBundle(java.lang.String resourceName, java.lang.Integer languageId) throws com.ibm.commerce.exception.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:
resourceName
- The name of the resource, using '.' as the namespace delimiterlanguageId
- The language IDcom.ibm.commerce.exception.ECException
- The com.ibm.commerce.exception.ECException exceptionpublic com.ibm.commerce.catalog.beans.CatalogDataBean[] getSalesCatalogs()
public com.ibm.commerce.catalog.beans.CatalogDataBean[] getStoreCatalogs() throws com.ibm.commerce.exception.ECException
getStoreCatalogs
in interface StoreSmartDataBean
com.ibm.commerce.exception.ECException
- The com.ibm.commerce.exception.ECExceptionpublic static java.lang.String getStoreContextPath() throws java.lang.Exception
java.lang.Exception
- The java.lang.Exceptionpublic CurrencyData[] getStoreCurrencies()
public CurrencyData[] getStoreCurrencies(java.lang.Integer anLanguageId)
anLanguageId
- the language for the descriptions.
Specify null
for the languageId returned by getCommandContext().getLanguageId()
.public com.ibm.commerce.common.objects.StoreDefaultAccessBean getStoreDefault()
StoreDefaultAccessBean
object.getStoreDefault
in class com.ibm.commerce.common.objects.StoreAccessBean
public java.lang.String getStoreDefaultCurrency()
public java.lang.Long getStoreDefaultQuoteConfigExpiryPeriod()
public StoreEntityDescriptionDataBean getStoreEntityDescriptionDataBean()
StoreEntityDescriptionDataBean
public java.lang.String getStoreId()
getStoreId
in interface StoreSmartDataBean
public java.lang.String getStorePartnerId()
public java.lang.Integer[] getStorePath(java.lang.String storeRelationshipTypeName) throws javax.naming.NamingException, java.sql.SQLException
getRelatedStores
, with the additional semantic
that if there are no related stores, this store's id is returned.getStorePath
in class com.ibm.commerce.common.objects.StoreAccessBean
storeRelationshipTypeName
- the store relationship type namejavax.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.public java.lang.Integer[] getStorePathByStoreRelationshipTypeName() throws javax.naming.NamingException, java.sql.SQLException
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.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.#getStorePath(String)}
,
#setStoreRelationshipTypeName(String)}
public java.lang.Integer[] getStoresForRelatedStore(java.lang.String storeRelationshipTypeName) throws javax.naming.NamingException, java.sql.SQLException
getStoresForRelatedStore
in class com.ibm.commerce.common.objects.StoreAccessBean
storeRelationshipTypeName
- the store relationship type namejavax.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.public java.lang.Integer[] getStoresForRelatedStoreByStoreRelationshipTypeName() throws javax.naming.NamingException, java.sql.SQLException
setStoreRelationshipTypeName(String)
.
The related store ids are sorted in ascending order of the store relationship sequence.storeRelationshipTypeName
- the store relationship type namejavax.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.#getStoresForRelatedStore(String)}
,
#setStoreRelationshipTypeName(String)}
public java.util.Enumeration getTaxCategory(java.lang.Integer taxType)
getTaxCategory
in class com.ibm.commerce.common.objects.StoreAccessBean
taxType
- tax typepublic boolean isBuyerOrganizationRegisteredToStore(java.lang.Long lBuyerOrgId)
lBuyerOrgId
- The memberId of a buyer organization.public boolean isBuyerOrganizationRegisteredToStore(java.lang.String strBuyerOrgDN)
strBuyerOrgDN
- The distinguished name of a buyer organizationpublic void populate() throws java.lang.Exception
DataBeanManager.activate()
executes.populate
in interface com.ibm.commerce.beans.SmartDataBean
java.lang.Exception
- The java.lang.Exception exception.public void setCommandContext(com.ibm.commerce.command.CommandContext aCommandContext)
setCommandContext
in interface com.ibm.commerce.beans.SmartDataBean
aCommandContext
- The command context to set within this bean.public void setFilePath(java.lang.String filePath)
filePath
- The file pathpublic void setJspPath(java.lang.String jspPath)
jspPath
- The JSP pathpublic void setJspStoreDir(java.lang.String storeDir)
storeDir
- The JSP store directory.public void setRequestProperties(com.ibm.commerce.datatype.TypedProperty requestProperty)
setRequestProperties
in interface com.ibm.commerce.beans.InputDataBean
requestProperty
- The request property to set within this bean.com.ibm.commerce.exception.ECException
- The ECException exception.public void setStoreId(java.lang.String storeId)
setStoreId
in interface StoreInputDataBean
storeId
- The store IDpublic void setStoreRelationshipTypeName(java.lang.String storeRelationshipTypeName)
storeRelationshipTypeName
- The store relationship type name.