com.ibm.commerce.common.beans

Class StoreErrorDataBean

  • java.lang.Object
    • com.ibm.commerce.beans.InputDataBeanImpl
      • com.ibm.commerce.beans.SmartDataBeanImpl
        • com.ibm.commerce.common.beans.StoreErrorDataBean
  • All Implemented Interfaces:
    com.ibm.commerce.beans.DataBean, com.ibm.commerce.beans.InputDataBean, com.ibm.commerce.beans.SmartDataBean, java.io.Serializable

    public class StoreErrorDataBean
extends com.ibm.commerce.beans.SmartDataBeanImpl
    Databean for displaying store error messages. Store error message keys are in the form of <ECMessage key>.<error code>. More javadoc to follow.
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      The IBM copyright string.

      • Fields inherited from interface com.ibm.commerce.beans.DataBean

        emptyString

    • Constructor Summary

      Constructors 
      Constructor and Description
      StoreErrorDataBean()
      Constructor for StoreErrorDataBean.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.String getECMessageKey()
      Returns the ECMessage key.
      java.lang.String getKey()
      Returns the store error message key.
      java.lang.String[] getKeys()
      Returns the store error message keys.
      java.lang.String getMessage()
      Returns the store error messages.
      java.lang.Object[] getMessageParameters()
      Returns the message parameters.
      java.lang.String[] getMessages()
      Returns the store error message.
      void populate()
      Populates this databean.
      void setECMessage(com.ibm.commerce.ras.ECMessage aECMessage)
      Sets the ECMessage.
      void setExceptionData(com.ibm.commerce.datatype.TypedProperty aExceptionData)
      Sets the exception data.
      void setMessageParameters(java.lang.Object[] aMessageParameters)
      Sets the message parameters.
      void setResourceBundleName(java.lang.String astrResourceBundleName)
      Sets the name of the resource bundle where the store error messages will be retrieved.

      • Methods inherited from class com.ibm.commerce.beans.SmartDataBeanImpl

        fulfills, getCommandContext, getHttpRequest, getHttpResponse, getResources, getViewCommandContext, setCommandContext, setHttpRequest, setHttpResponse, setViewCommandContext

      • Methods inherited from class com.ibm.commerce.beans.InputDataBeanImpl

        getRequestProperties, setRequestProperties

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

      • Methods inherited from interface com.ibm.commerce.beans.InputDataBean

        getRequestProperties, setRequestProperties

    • Field Detail

      • COPYRIGHT

        public static final java.lang.String COPYRIGHT
        The IBM copyright string.
        See Also:
        Constant Field Values

    • Constructor Detail

      • StoreErrorDataBean

        public StoreErrorDataBean()
        Constructor for StoreErrorDataBean.

    • Method Detail

      • getECMessageKey

        public java.lang.String getECMessageKey()
        Returns the ECMessage key.
        Returns:
        the ECMessage key.

      • getKey

        public java.lang.String getKey()
        Returns the store error message key. This method will return the first store error message key if there are many.
        Returns:
        the store error message key.
        See Also:
        getKeys()

      • getKeys

        public java.lang.String[] getKeys()
        Returns the store error message keys. This method will return a store error message key for each error code.
        Returns:
        the store error message keys.
        See Also:
        getKey()

      • getMessage

        public java.lang.String getMessage()
        Returns the store error messages. This method will return a store error message for each store error message key.
        Returns:
        the store error messages.

      • getMessageParameters

        public java.lang.Object[] getMessageParameters()
        Returns the message parameters.
        Returns:
        the message parameters.

      • getMessages

        public java.lang.String[] getMessages()
        Returns the store error message. This method will return the first store error message if there are many.
        Returns:
        the store error message.

      • populate

        public void populate()
        Populates this databean. This method does the following:
        1. extracts the ECMessage from the request properties.
        2. extracts the exception data from the request properties.
        3. extracts the message parameters from the request properties.
        4. composes the store error message key(s) from the ECMessage key and the error code(s).
        5. retrieves the store error message(s) from the resource bundle specified.
        Specified by:
        populate in interface com.ibm.commerce.beans.SmartDataBean
        Overrides:
        populate in class com.ibm.commerce.beans.SmartDataBeanImpl
        See Also:
        setECMessage(ECMessage), setExceptionData(TypedProperty), setMessageParameters(Object[])

      • setECMessage

        public void setECMessage(com.ibm.commerce.ras.ECMessage aECMessage)
        Sets the ECMessage.
        Parameters:
        aECMessage - the ECMessage.

      • setExceptionData

        public void setExceptionData(com.ibm.commerce.datatype.TypedProperty aExceptionData)
        Sets the exception data.
        Parameters:
        aExceptionData - the exception data.

      • setMessageParameters

        public void setMessageParameters(java.lang.Object[] aMessageParameters)
        Sets the message parameters.
        Parameters:
        aMessageParameters - the message parameters.

      • setResourceBundleName

        public void setResourceBundleName(java.lang.String astrResourceBundleName)
        Sets the name of the resource bundle where the store error messages will be retrieved.
        Parameters:
        astrResourceBundleName - the name of the resource bundle.
Skip navigation links