com.ibm.commerce.pa.beans
Class DynamicDataBeanImpl

java.lang.Object
  |
  +--com.ibm.commerce.pa.beans.DynamicDataBeanImpl
All Implemented Interfaces:
CommandDataBean, DataBean, DynamicDataBean, InputDataBean, java.io.Serializable
Direct Known Subclasses:
ColumnDataBean, ElementDataBean, FormDataBean, ItemDataBean, ListDataBean, TableDataBean, TreeDataBean, TreeNodeDataBean

public abstract class DynamicDataBeanImpl
extends java.lang.Object
implements DynamicDataBean

This is the implementation of the DynamicDataBean interface and contained in the inheritance tree of most of the Product Advisor databeans.

See Also:
Serialized Form

Field Summary
protected  com.ibm.commerce.pa.beans.ConstraintList constraintList
           
static java.lang.String COPYRIGHT
           
protected  com.ibm.commerce.pa.beans.AbstractDynamicWidget defaultWidget
           
protected  int errorCode
          The error code for the bean.
protected  java.lang.String errorMessage
          The error message for the bean.
protected  java.lang.String interfaceName
          The interface name of the command to invoke to return a populated instance of the bean.
protected  DataBeanDescriptor metaData
           
protected  java.lang.String pageName
          The page name for the current request of this bean.
protected  DynamicDataBean parent
           
protected  java.lang.String parentName
           
protected  TypedProperty requestProperties
           
protected  java.lang.String scriptName
          The Servlet Path for current request of this bean.
 
Fields inherited from interface com.ibm.commerce.beans.DataBean
emptyString
 
Constructor Summary
DynamicDataBeanImpl()
          DynamicDataBeanImpl constructor.
 
Method Summary
 void addConstraint(java.lang.String columnName, java.lang.String operation, java.lang.String value, java.lang.String dataType, java.lang.String languageId)
          Add a constraint that should be used, for the current page only, in addition to the feature constraints selected through the metaphor and passed in as URL parameters.
abstract  void copy(DynamicDataBean ds)
          Make this object a copy of the bean supplied.
 java.lang.String getCommandInterfaceName()
          Return the name of the command that populates this bean.
 com.ibm.commerce.pa.beans.ConstraintList getConstraintList()
          Return the list of feature constraints in effect.
 com.ibm.commerce.pa.beans.AbstractDynamicWidget getDefaultWidget()
          Return the default widget to use to render this bean.
 int getErrorCode()
          Return any error code generated while populating this bean.
 java.lang.String getErrorMessage()
          Return any error message generated while populating this bean.
 DataBeanDescriptor getMetaData()
          Return the DataBeanDescriptor for this bean.
 java.lang.String getPageName()
          Return the page name for the page that this bean is on.
 DynamicDataBean getParent()
          Return the parent bean.
 java.lang.String getParentName()
          Return the name of the class of the parent bean.
 TypedProperty getRequestProperties()
          Return the request properties.
 java.lang.String getScriptName()
          Return the script name for the page that this bean is on.
 void setCommandInterfaceName(java.lang.String ifname)
          Set the name of the command that populates this bean.
 void setConstraintList(com.ibm.commerce.pa.beans.ConstraintList newConstraintList)
          Set the list of feature constraints to be used by this bean.
 void setDefaultWidget(com.ibm.commerce.pa.beans.AbstractDynamicWidget newValue)
          Set the default widget used to render this bean.
 void setErrorCode(int newCode)
          Set the error code used for this bean.
 void setErrorMessage(java.lang.String newMessage)
          Set the error message for this bean.
 void setMetaData(DataBeanDescriptor newValue)
          Set the descriptor for this bean.
 void setPageName(java.lang.String newPage)
          Set the name of the page that this bean is on.
 void setParent(DynamicDataBean newValue)
          Set the parent of this bean.
 void setParentName(java.lang.String newValue)
          Set the name of the class of the parent of this bean.
 void setRequestProperties(TypedProperty reqProperties)
          Set the request properties.
 void setScriptName(java.lang.String newScriptName)
          Set the name of the script for the page that this bean is on.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

constraintList

protected com.ibm.commerce.pa.beans.ConstraintList constraintList

COPYRIGHT

public static final java.lang.String COPYRIGHT

defaultWidget

protected com.ibm.commerce.pa.beans.AbstractDynamicWidget defaultWidget

errorCode

protected int errorCode
The error code for the bean. The code is available if the request to activate this bean fails. A zero indicates no failure.
The display name of this field is "Error code".

errorMessage

protected java.lang.String errorMessage
The error message for the bean. The message is available if the request to activate this bean fails.
The display name of this field is "Error message".

interfaceName

protected java.lang.String interfaceName
The interface name of the command to invoke to return a populated instance of the bean. This is used internally only.

metaData

protected DataBeanDescriptor metaData

pageName

protected java.lang.String pageName
The page name for the current request of this bean. This is used internally by the bean and commands.

parent

protected DynamicDataBean parent

parentName

protected java.lang.String parentName

requestProperties

protected TypedProperty requestProperties

scriptName

protected java.lang.String scriptName
The Servlet Path for current request of this bean.
Constructor Detail

DynamicDataBeanImpl

public DynamicDataBeanImpl()
DynamicDataBeanImpl constructor.
Method Detail

addConstraint

public void addConstraint(java.lang.String columnName,
                          java.lang.String operation,
                          java.lang.String value,
                          java.lang.String dataType,
                          java.lang.String languageId)
Add a constraint that should be used, for the current page only, in addition to the feature constraints selected through the metaphor and passed in as URL parameters.
Parameters:
columnName - The column name of the constraint.
operation - The operation of the constraint.
value - The value of the constraint.
dataType - The datatype of the value.
languageId - The language id.

copy

public abstract void copy(DynamicDataBean ds)
Make this object a copy of the bean supplied.
Specified by:
copy in interface DynamicDataBean
Parameters:
ds - The DynamicDataBean to use as the source for the copy.

getCommandInterfaceName

public java.lang.String getCommandInterfaceName()
Return the name of the command that populates this bean.
Specified by:
getCommandInterfaceName in interface CommandDataBean
Returns:
java.lang.String

getConstraintList

public com.ibm.commerce.pa.beans.ConstraintList getConstraintList()
Return the list of feature constraints in effect.
Returns:
com.ibm.commerce.pa.metaphor.ConstraintList

getDefaultWidget

public com.ibm.commerce.pa.beans.AbstractDynamicWidget getDefaultWidget()
Return the default widget to use to render this bean.
Specified by:
getDefaultWidget in interface DynamicDataBean
Returns:
com.ibm.commerce.pa.widget.AbstractDynamicWidget

getErrorCode

public int getErrorCode()
Return any error code generated while populating this bean.
Returns:
java.lang.Integer

getErrorMessage

public java.lang.String getErrorMessage()
Return any error message generated while populating this bean.
Returns:
java.lang.String

getMetaData

public DataBeanDescriptor getMetaData()
Return the DataBeanDescriptor for this bean.
Specified by:
getMetaData in interface DynamicDataBean
Returns:
com.ibm.commerce.beans.DataBeanDescriptor

getPageName

public java.lang.String getPageName()
Return the page name for the page that this bean is on.
Specified by:
getPageName in interface DynamicDataBean
Returns:
java.lang.String

getParent

public DynamicDataBean getParent()
Return the parent bean.
Specified by:
getParent in interface DynamicDataBean
Returns:
com.ibm.commerce.pa.beans.DynamicDataBean

getParentName

public java.lang.String getParentName()
Return the name of the class of the parent bean.
Specified by:
getParentName in interface DynamicDataBean
Returns:
java.lang.String

getRequestProperties

public TypedProperty getRequestProperties()
Return the request properties.
Specified by:
getRequestProperties in interface InputDataBean
Returns:
com.ibm.commerce.datatype.TypedProperty

getScriptName

public java.lang.String getScriptName()
Return the script name for the page that this bean is on.
Specified by:
getScriptName in interface DynamicDataBean
Returns:
java.lang.String

setCommandInterfaceName

public void setCommandInterfaceName(java.lang.String ifname)
Set the name of the command that populates this bean.
Specified by:
setCommandInterfaceName in interface CommandDataBean
Parameters:
ifname - java.lang.String

setConstraintList

public void setConstraintList(com.ibm.commerce.pa.beans.ConstraintList newConstraintList)
Set the list of feature constraints to be used by this bean.
Parameters:
newConstraintList - com.ibm.commerce.pa.metaphor.ConstraintList

setDefaultWidget

public void setDefaultWidget(com.ibm.commerce.pa.beans.AbstractDynamicWidget newValue)
Set the default widget used to render this bean.
Specified by:
setDefaultWidget in interface DynamicDataBean
Parameters:
newValue - com.ibm.commerce.pa.widget.AbstractDynamicWidget

setErrorCode

public void setErrorCode(int newCode)
Set the error code used for this bean.
Parameters:
newCode - int

setErrorMessage

public void setErrorMessage(java.lang.String newMessage)
Set the error message for this bean.
Parameters:
newMessage - java.lang.String

setMetaData

public void setMetaData(DataBeanDescriptor newValue)
Set the descriptor for this bean.
Specified by:
setMetaData in interface DynamicDataBean
Parameters:
newValue - com.ibm.commerce.beans.DataBeanDescriptor

setPageName

public void setPageName(java.lang.String newPage)
Set the name of the page that this bean is on.
Specified by:
setPageName in interface DynamicDataBean
Parameters:
newPage - java.lang.String

setParent

public void setParent(DynamicDataBean newValue)
Set the parent of this bean.
Specified by:
setParent in interface DynamicDataBean
Parameters:
newValue - com.ibm.commerce.pa.beans.DynamicDataBean

setParentName

public void setParentName(java.lang.String newValue)
Set the name of the class of the parent of this bean.
Specified by:
setParentName in interface DynamicDataBean
Parameters:
newValue - java.lang.String

setRequestProperties

public void setRequestProperties(TypedProperty reqProperties)
Set the request properties.
Specified by:
setRequestProperties in interface InputDataBean
Parameters:
reqProperties - com.ibm.commerce.datatype.TypedProperty

setScriptName

public void setScriptName(java.lang.String newScriptName)
Set the name of the script for the page that this bean is on.
Specified by:
setScriptName in interface DynamicDataBean
Parameters:
newScriptName - java.lang.String