com.ibm.commerce.beans
Class WcsAppDataBean

java.lang.Object
  |
  +--com.ibm.commerce.beans.InputDataBeanImpl
        |
        +--com.ibm.commerce.beans.SmartDataBeanImpl
              |
              +--com.ibm.commerce.beans.WcsAppDataBean
All Implemented Interfaces:
DataBean, InputDataBean, java.io.Serializable, SmartDataBean

public class WcsAppDataBean
extends SmartDataBeanImpl

The data bean allows a JSP to register/cache and access instance variables associated with this instance of WCS application.

See Also:
Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          IBM Copyright notice field.
 
Fields inherited from class com.ibm.commerce.beans. SmartDataBeanImpl
commandContext
 
Fields inherited from class com.ibm.commerce.beans. InputDataBeanImpl
requestProperties
 
Fields inherited from interface com.ibm.commerce.beans. DataBean
emptyString
 
Constructor Summary
WcsAppDataBean()
          Creates the WcsApp Data Bean.
 
Method Summary
 java.lang.Object getCachedObject(java.lang.String name)
          Retrieve a cached object with the given name.
  ConfigProperties getConfigProperties()
          Gets the configuration properties object.
 java.lang.String getInstanceName()
          Gets the instance name / clone name.
  RegistryManager getRegistryManager()
          Gets the registry manager for this application.
  StoreRegistry getStoreRegistry()
          Gets the store registry for this application.
 java.lang.String getWebPath()
          Gets the store web path association with this web application.
 void populate()
          This method does not do anything because the objects are already cache somewhere and the corresponding getter knows where to get the object.
 void setCachedObject(java.lang.String name, java.lang.Object obj)
          This method register an object with the WcsApp cache.
 
Methods inherited from class com.ibm.commerce.beans. SmartDataBeanImpl
fulfills, getCommandContext, getResources, setCommandContext
 
Methods inherited from class com.ibm.commerce.beans. InputDataBeanImpl
getRequestProperties, setRequestProperties
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.commerce.beans. InputDataBean
getRequestProperties, setRequestProperties
 

Field Detail
public static final java.lang.String COPYRIGHT
IBM Copyright notice field.
See Also:
Constant Field Values
Constructor Detail

WcsAppDataBean

public WcsAppDataBean()
Creates the WcsApp Data Bean.
Method Detail

getCachedObject

public java.lang.Object getCachedObject(java.lang.String name)
Retrieve a cached object with the given name.
Parameters:
name - the name of cached object.
Returns:
the cached object or null if the object is not cached.

getConfigProperties

public ConfigProperties getConfigProperties()
Gets the configuration properties object.
Returns:
The configuration property object.

getInstanceName

public java.lang.String getInstanceName()
Gets the instance name / clone name.
Returns:
The Commerce Server instance name.

getRegistryManager

public RegistryManager getRegistryManager()
Gets the registry manager for this application.
Returns:
The registry manager.

getStoreRegistry

public StoreRegistry getStoreRegistry()
Gets the store registry for this application.
Returns:
The store registry.

getWebPath

public java.lang.String getWebPath()
Gets the store web path association with this web application.
Returns:
The store web path.

populate

public void populate()
              throws java.lang.Exception
This method does not do anything because the objects are already cache somewhere and the corresponding getter knows where to get the object.
Specified by:
populate in interface SmartDataBean
Overrides:
populate in class SmartDataBeanImpl
Throws:
java.lang.Exception - should never happen.

setCachedObject

public void setCachedObject(java.lang.String name,
                            java.lang.Object obj)
This method register an object with the WcsApp cache.
Parameters:
name - the name of the object to cache.
obj - the object to cache.