com.ibm.commerce.tools.contract.beans

Class DisplayCustomizationTCDataBean

  • java.lang.Object
    • com.ibm.commerce.tools.contract.beans.DisplayCustomizationTCDataBean
  • All Implemented Interfaces:
    com.ibm.commerce.beans.DataBean, com.ibm.commerce.beans.InputDataBean, com.ibm.commerce.beans.SmartDataBean, com.ibm.commerce.security.Delegator, java.io.Serializable

    public class DisplayCustomizationTCDataBean
extends java.lang.Object
implements com.ibm.commerce.beans.SmartDataBean, com.ibm.commerce.security.Delegator
    Retrieve all the data associated with a Display Customization Term and Condition Set the account and language identifiers in order to populate the bean.
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String DISPLAY_TYPE_ATTACHMENT
      Display type attachment
      static java.lang.String DISPLAY_TYPE_TEXTFIELD
      Display type textfield

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

        emptyString

    • Constructor Summary

      Constructors 
      Constructor and Description
      DisplayCustomizationTCDataBean()
      DisplayCustomizationTCDataBean default constructor, allows to be used in JSP snippets with tag.
      DisplayCustomizationTCDataBean(java.lang.Long newAccountId, java.lang.Integer newLangId)
      Construct an DisplayCustomizationTCDataBean from an existing account identifier Find the Display Customization terms and conditions in the account
      DisplayCustomizationTCDataBean(java.lang.String newUserId, java.lang.Integer newStoreId, java.lang.Integer newLangId)
      Construct an DisplayCustomizationTCDataBean from an existing member & store identifiers Find the Display Customization terms and conditions in the account

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.Long getAccountId()
      Get the account identifier for the account this term and condition is in
      AttachmentDataBean getAttachment(int indexNumber)
      Get a specific attachment databean for this T&C
      java.lang.String getAttachmentReferenceNumber(int indexNumber)
      Get a specific attachment reference number for this T&C
      java.lang.String[] getAttachmentURL()
      Get a whole list of the display attachment URL for this T&C
      java.lang.String getAttachmentURL(int indexNumber)
      Get a specific display attachment URL for this T&C
      com.ibm.commerce.command.CommandContext getCommandContext()
      Returns the current command's context
      com.ibm.commerce.security.Protectable getDelegate()
      Return the access control delegate of this databean
      java.lang.String getDisplayLogoReferenceNumber(int indexNumber)
      Get a specific display logo (attachment) reference number for this T&C
      java.lang.String[] getDisplayText()
      Get a whole list of the display text for this T&C
      java.lang.String getDisplayText(int indexNumber)
      Get a specific display text for this T&C
      java.lang.String getDisplayTextReferenceNumber(int indexNumber)
      Get a specific display text's reference number for this T&C
      boolean getHasDisplayLogo()
      Is there display logo attachment term and condition in the account
      boolean getHasDisplayText()
      Is there display text term and condition in the account
      java.lang.Integer getLanguageId()
      Get the language ID
      com.ibm.commerce.datatype.TypedProperty getRequestProperties()
      Gets request properties
      java.lang.Integer getStoreId()
      Get the store ID
      java.lang.Long getUserId()
      Get the user ID
      void populate()
      Get the Display Customization term and conditions in the account
      void setAccountId(java.lang.Long newAccountId)
      Set the account identifier for the account this term and condition is in
      void setCommandContext(com.ibm.commerce.command.CommandContext newICommandContext)
      Set the command context
      void setLanguageId(java.lang.Integer newLangId)
      Set the language ID
      void setRequestProperties(com.ibm.commerce.datatype.TypedProperty param)
      Set the request properties.
      void setStoreId(java.lang.Integer newStoreId)
      Set the store ID, it also uses the user ID together to retrieve & set the proper account ID for this term & condition.
      void setUserId(java.lang.Long newUserId)
      Set the user ID

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • DISPLAY_TYPE_ATTACHMENT

        public static final java.lang.String DISPLAY_TYPE_ATTACHMENT
        Display type attachment
        See Also:
        Constant Field Values

      • DISPLAY_TYPE_TEXTFIELD

        public static final java.lang.String DISPLAY_TYPE_TEXTFIELD
        Display type textfield
        See Also:
        Constant Field Values

    • Constructor Detail

      • DisplayCustomizationTCDataBean

        public DisplayCustomizationTCDataBean()
        DisplayCustomizationTCDataBean default constructor, allows to be used in JSP snippets with tag. If using this default constructor, caller programs must invoke the proper setters before executing the populate() method or the DataBeanManager.activate() method. Recommended setters are described below:

        Option #1: invokes setLanguageId() & setAccountId()
        Option #2: invokes setLanguageId(), setUserId(), & setStoreId()

        NOTE: For option#2, caller must invoke the setters in the following sequential order:
        setLanguageId()
        setUserId()
        setStoreId()

      • DisplayCustomizationTCDataBean

        public DisplayCustomizationTCDataBean(java.lang.Long newAccountId,
                                      java.lang.Integer newLangId)
        Construct an DisplayCustomizationTCDataBean from an existing account identifier Find the Display Customization terms and conditions in the account
        Parameters:
        newAccountId - Long An existing account identifier
        newLangId - Integer The language identifier for which language to retrieve the data

      • DisplayCustomizationTCDataBean

        public DisplayCustomizationTCDataBean(java.lang.String newUserId,
                                      java.lang.Integer newStoreId,
                                      java.lang.Integer newLangId)
        Construct an DisplayCustomizationTCDataBean from an existing member & store identifiers Find the Display Customization terms and conditions in the account
        Parameters:
        newUserId - String An existing member identifier
        newStoreId - Integer An existing store identifier
        newLangId - Integer The language identifier for which language to retrieve the data

    • Method Detail

      • getAccountId

        public java.lang.Long getAccountId()
        Get the account identifier for the account this term and condition is in
        Returns:
        Long

      • getAttachment

        public AttachmentDataBean getAttachment(int indexNumber)
                                 throws com.ibm.commerce.exception.ECException
        Get a specific attachment databean for this T&C
        Parameters:
        indexNumber - attachment's index number for this T&C
        Returns:
        an attachment data bean for this T&C
        Throws:
        com.ibm.commerce.exception.ECException

      • getAttachmentReferenceNumber

        public java.lang.String getAttachmentReferenceNumber(int indexNumber)
                                              throws com.ibm.commerce.exception.ECException
        Get a specific attachment reference number for this T&C
        Parameters:
        indexNumber - attachment's index number for this T&C
        Returns:
        an attachment reference number for this T&C
        Throws:
        com.ibm.commerce.exception.ECException

      • getAttachmentURL

        public java.lang.String[] getAttachmentURL()
        Get a whole list of the display attachment URL for this T&C
        Returns:
        String[] a list of display attachment URL values for this T&C

      • getAttachmentURL

        public java.lang.String getAttachmentURL(int indexNumber)
        Get a specific display attachment URL for this T&C
        Parameters:
        indexNumber - display attachment's index number for this T&C
        Returns:
        a display attachment URL value for this T&C

      • getCommandContext

        public com.ibm.commerce.command.CommandContext getCommandContext()
        Returns the current command's context
        Specified by:
        getCommandContext in interface com.ibm.commerce.beans.SmartDataBean
        Returns:
        com.ibm.commerce.command.CommandContext

      • getDelegate

        public com.ibm.commerce.security.Protectable getDelegate()
                                                  throws java.lang.Exception
        Return the access control delegate of this databean
        Specified by:
        getDelegate in interface com.ibm.commerce.security.Delegator
        Returns:
        com.ibm.commerce.security.Protectable
        Throws:
        java.lang.Exception

      • getDisplayLogoReferenceNumber

        public java.lang.String getDisplayLogoReferenceNumber(int indexNumber)
                                               throws com.ibm.commerce.exception.ECException
        Get a specific display logo (attachment) reference number for this T&C
        Parameters:
        indexNumber - attachment's index number for this T&C
        Returns:
        an attachment reference number for this T&C
        Throws:
        com.ibm.commerce.exception.ECException

      • getDisplayText

        public java.lang.String[] getDisplayText()
                                  throws com.ibm.commerce.exception.ECException
        Get a whole list of the display text for this T&C
        Returns:
        String[] a list of display text values for this T&C
        Throws:
        com.ibm.commerce.exception.ECException

      • getDisplayText

        public java.lang.String getDisplayText(int indexNumber)
                                throws com.ibm.commerce.exception.ECException
        Get a specific display text for this T&C
        Parameters:
        indexNumber - display text's index number for this T&C
        Returns:
        a display text value for this T&C
        Throws:
        com.ibm.commerce.exception.ECException

      • getDisplayTextReferenceNumber

        public java.lang.String getDisplayTextReferenceNumber(int indexNumber)
                                               throws com.ibm.commerce.exception.ECException
        Get a specific display text's reference number for this T&C
        Parameters:
        indexNumber - display text's index number for this T&C
        Returns:
        a display text's reference number for this T&C
        Throws:
        com.ibm.commerce.exception.ECException

      • getHasDisplayLogo

        public boolean getHasDisplayLogo()
        Is there display logo attachment term and condition in the account
        Returns:
        boolean

      • getHasDisplayText

        public boolean getHasDisplayText()
        Is there display text term and condition in the account
        Returns:
        boolean

      • getLanguageId

        public java.lang.Integer getLanguageId()
        Get the language ID
        Returns:
        Integer The language identifier for which language has been set to this object

      • getRequestProperties

        public com.ibm.commerce.datatype.TypedProperty getRequestProperties()
        Gets request properties
        Specified by:
        getRequestProperties in interface com.ibm.commerce.beans.InputDataBean
        Returns:
        null

      • getStoreId

        public java.lang.Integer getStoreId()
        Get the store ID
        Returns:
        Integer The store identifier has been set to this object

      • getUserId

        public java.lang.Long getUserId()
        Get the user ID
        Returns:
        Long The user member identifier has been set to this object

      • populate

        public void populate()
              throws java.lang.Exception
        Get the Display Customization term and conditions in the account
        Specified by:
        populate in interface com.ibm.commerce.beans.SmartDataBean
        Throws:
        java.lang.Exception

      • setAccountId

        public void setAccountId(java.lang.Long newAccountId)
        Set the account identifier for the account this term and condition is in
        Parameters:
        newAccountId - Long An existing account identifier for this term & condition

      • setCommandContext

        public void setCommandContext(com.ibm.commerce.command.CommandContext newICommandContext)
        Set the command context
        Specified by:
        setCommandContext in interface com.ibm.commerce.beans.SmartDataBean
        Parameters:
        newICommandContext - com.ibm.commerce.command.CommandContext

      • setLanguageId

        public void setLanguageId(java.lang.Integer newLangId)
        Set the language ID
        Parameters:
        newLangId - Integer The language identifier for which language to retrieve the data

      • setRequestProperties

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

      • setStoreId

        public void setStoreId(java.lang.Integer newStoreId)
        Set the store ID, it also uses the user ID together to retrieve & set the proper account ID for this term & condition. This method should be used conjunction with the method setUserId(). Please see details in the default constructor.
        Parameters:
        newStoreId - String An existing store identifier

      • setUserId

        public void setUserId(java.lang.Long newUserId)
        Set the user ID
        Parameters:
        newUserId - Long An existing member identifier
Skip navigation links