com.ibm.commerce.beans
Class DataBeanHelper

java.lang.Object
  |
  +--com.ibm.commerce.beans.DataBeanHelper
All Implemented Interfaces:
java.io.Serializable

public class DataBeanHelper
extends java.lang.Object
implements java.io.Serializable

The helper class for all databean objects.

See Also:
Serialized Form

Field Summary
protected  int errorCode
           
protected  java.lang.String errorMessage
           
protected  java.lang.String interfaceName
           
protected  java.lang.String pageName
           
protected  java.lang.String storeReferenceNumber
           
protected  java.lang.String userReferenceNumber
           
 
Constructor Summary
DataBeanHelper()
          The default constructor for the base class of databeans.
DataBeanHelper(java.lang.String interfaceName)
          This constructor for the DataBeanHelper initialize the default interface name and class name of the data bean command.
 
Method Summary
 int getErrorCode()
          Gets the error code for the databean.
 java.lang.String getErrorMessage()
          Gets the error message for the databean.
 java.lang.String getInterfaceName()
          Gets the interface name of the command to invoke to return a populated instance of the databean.
 java.lang.String getPageName()
          Gets the page name for the current request of this databean.
 void setErrorCode(int newCode)
          Sets the error code for the databean.
 void setErrorMessage(java.lang.String newMessage)
          Sets the error message for the databean.
protected  void setInterfaceName(java.lang.String newInterfaceName)
          Sets the interface name of the command to invoke to return a populated instance of the databean.
 void setPageName(java.lang.String newPage)
          Sets the page name for the current request of this databean.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

errorCode

protected int errorCode

errorMessage

protected java.lang.String errorMessage

interfaceName

protected java.lang.String interfaceName

pageName

protected java.lang.String pageName

storeReferenceNumber

protected java.lang.String storeReferenceNumber

userReferenceNumber

protected java.lang.String userReferenceNumber
Constructor Detail

DataBeanHelper

public DataBeanHelper()
The default constructor for the base class of databeans. All base fields are initialized to "" strings.

DataBeanHelper

public DataBeanHelper(java.lang.String interfaceName)
This constructor for the DataBeanHelper initialize the default interface name and class name of the data bean command. It also initializes all other fields to "" strings.
Parameters:
interfaceName - String - if name of data bean command
cmdName - String - default implementation class for the data bean command
Method Detail

getErrorCode

public int getErrorCode()
Gets the error code for the databean. The code is available if the request to activate this databean fails.
Returns:
(int) The error code.

getErrorMessage

public java.lang.String getErrorMessage()
Gets the error message for the databean. The message is available if the request to activate this databean fails.
Returns:
(java.lang.String) The error message.

getInterfaceName

public java.lang.String getInterfaceName()
Gets the interface name of the command to invoke to return a populated instance of the databean.
Returns:
(java.lang.String) The interface name.

getPageName

public java.lang.String getPageName()
Gets the page name for the current request of this databean.
Returns:
(java.lang.String) The page name.

setErrorCode

public void setErrorCode(int newCode)
Sets the error code for the databean. The code is available if the request to activate this databean fails.
Parameters:
newCode - The error code.

setErrorMessage

public void setErrorMessage(java.lang.String newMessage)
Sets the error message for the databean. The message is available if the request to activate this databean fails.
Parameters:
newMessage - The error message.

setInterfaceName

protected void setInterfaceName(java.lang.String newInterfaceName)
Sets the interface name of the command to invoke to return a populated instance of the databean.
Parameters:
newInterfaceName - The interface name.

setPageName

public void setPageName(java.lang.String newPage)
Sets the page name for the current request of this databean.
Parameters:
newPage - The page name.