com.ibm.commerce.tools.contract.beans

Class StoreCreationWizardDataBean

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


    public class StoreCreationWizardDataBean
    extends java.lang.Object
    implements com.ibm.commerce.beans.SmartDataBean
    This data bean represents a Store Creation Wizard object. The StoreCreationWizardDataBean contains various methods used in Store Creation wizard including:
    • Gets all languages in WebSphere Commerce
    • Gets all currencies in WebSphere Commerce
    • Gets channel fulfillment center
    • Gets catalog asset stores
    • Gets hosted storefront asset stores
    • Gets user organization
    When creating store by wizard, the data bean will be called.
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static int CONSTANT_INDEX_DESCRIPTION
      A constant for the third index of a returned array.
      static int CONSTANT_INDEX_DISPLAYNAME
      A constant for the second index of a returned array.
      static int CONSTANT_INDEX_ID
      A constant for the first index of a returned array.
      static java.lang.String COPYRIGHT
      IBM copyright notice field.
      • Fields inherited from interface com.ibm.commerce.beans.DataBean

        emptyString
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.util.Vector getCatalogProfileStores()
      Looks for catalog profile store type stores and supplier catalog store type stores in the database with a master catalog.
      com.ibm.commerce.command.CommandContext getCommandContext()
      Returns the current command's context
      java.util.Vector getCurrencies()
      Gets all currencies in WebSphere Commerce.
      java.util.Vector getLanguages()
      Gets all languages in WebSphere Commerce.
      java.lang.String getOwnerPrimaryAddressId(java.lang.String astrOrgId)
      Gets the primary address ID based on a given organization ID with the address type "SB".
      java.util.Vector getProfileStores(java.lang.String[] astrStoretype)
      Looks for the given store type (for example: RPS) asset stores in the database.
      com.ibm.commerce.datatype.TypedProperty getRequestProperties()
      Gets the request properties.
      java.util.Vector getStoreCategories()
      Finds store categories available in the system.
      java.lang.String[] getSupportedLanguages(java.lang.String astrStoreId)
      Gets all the supported languages of a store.
      java.util.Vector getUserOrgs()
      Gets all the organizations which user has access to.
      void populate()
      This method is used to retrieve the data for the contract.
      void setCommandContext(com.ibm.commerce.command.CommandContext cc)
      Sets the command context.
      void setRequestProperties(com.ibm.commerce.datatype.TypedProperty reqProp)
      Sets the request properties.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • CONSTANT_INDEX_DESCRIPTION

        public static final int CONSTANT_INDEX_DESCRIPTION
        A constant for the third index of a returned array.
        See Also:
        Constant Field Values
      • CONSTANT_INDEX_DISPLAYNAME

        public static final int CONSTANT_INDEX_DISPLAYNAME
        A constant for the second index of a returned array.
        See Also:
        Constant Field Values
      • CONSTANT_INDEX_ID

        public static final int CONSTANT_INDEX_ID
        A constant for the first index of a returned array.
        See Also:
        Constant Field Values
      • COPYRIGHT

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

      • StoreCreationWizardDataBean

        public StoreCreationWizardDataBean()
        Constructs a StoreCreationWizardDataBean.
    • Method Detail

      • getCatalogProfileStores

        public java.util.Vector getCatalogProfileStores()
                                                 throws com.ibm.commerce.exception.ECSystemException
        Looks for catalog profile store type stores and supplier catalog store type stores in the database with a master catalog.

        Returns a Vector of String arrays, each of which contains three values:

        • Catalog Profile Store ID or Supplier Catalog Store ID
        • Catalog display name
        • Catalog description
        in that order.
        Returns:
        A Vector of String arrays as described. If no stores were found, the Vector will be empty. Will not be null.
        Throws:
        com.ibm.commerce.exception.ECSystemException - Thrown with message _ERR_GENERIC if an error occurs while getting the ID, name, or description.
      • 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
      • getCurrencies

        public java.util.Vector getCurrencies()
                                       throws com.ibm.commerce.exception.ECSystemException
        Gets all currencies in WebSphere Commerce.
        Returns:
        Vector of sorted currencies list
        Throws:
        ECSystemException
        - threw with message _ERR_GENERIC when an error occurred while getting currencies.
        com.ibm.commerce.exception.ECSystemException
      • getLanguages

        public java.util.Vector getLanguages()
                                      throws com.ibm.commerce.exception.ECSystemException
        Gets all languages in WebSphere Commerce.
        Returns:
        Vector of sorted languages list
        Throws:
        com.ibm.commerce.exception.ECSystemException - threw with message _ERR_GENERIC when an error occurred while getting languages.
      • getOwnerPrimaryAddressId

        public java.lang.String getOwnerPrimaryAddressId(java.lang.String astrOrgId)
                                                  throws com.ibm.commerce.exception.ECSystemException
        Gets the primary address ID based on a given organization ID with the address type "SB". If nothing is found, use address type "R".
        Returns null if nothing is found.
        Parameters:
        astrOrgId - The organization entity Id.
        Returns:
        The address Id of primary address.
        Throws:
        com.ibm.commerce.exception.ECSystemException - threw with message _ERR_GENERIC when an error occurred while getting the addressId.
      • getProfileStores

        public java.util.Vector getProfileStores(java.lang.String[] astrStoretype)
                                          throws com.ibm.commerce.exception.ECSystemException
        Looks for the given store type (for example: RPS) asset stores in the database.
        Returns a Vector of String array of three values: Profile Store Id, store display name and description respectively.
        Parameters:
        astrStoretype - The store type (for example: RPS).
        Returns:
        A Vector of String arrays
        Throws:
        com.ibm.commerce.exception.ECSystemException -
        threw with message _ERR_GENERIC when an error occurred while getting the Id, name, or description.
      • getRequestProperties

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

        public java.util.Vector getStoreCategories()
                                            throws com.ibm.commerce.exception.ECSystemException
        Finds store categories available in the system. Returns a Vector of String array of three values:
        Store category name, store category display name, and description respectively.
        Returns:
        Vector of String arrays
        Throws:
        com.ibm.commerce.exception.ECSystemException -
        threw with message _ERR_GENERIC when an error occurred while getting the Id, name, or description.
      • getSupportedLanguages

        public java.lang.String[] getSupportedLanguages(java.lang.String astrStoreId)
                                                 throws com.ibm.commerce.exception.ECSystemException
        Gets all the supported languages of a store.
        Parameters:
        astrStoreId - The store Id.
        Returns:
        A String array of supported languages Ids
        Throws:
        com.ibm.commerce.exception.ECSystemException - threw with message _ERR_GENERIC when an error occurred while getting languages.
      • getUserOrgs

        public java.util.Vector getUserOrgs()
                                     throws com.ibm.commerce.exception.ECSystemException
        Gets all the organizations which user has access to.
        Returns:
        Vector of sorted organization list
        Throws:
        com.ibm.commerce.exception.ECSystemException - threw with message _ERR_GENERIC when an error occurred while getting user's organizations.
      • populate

        public void populate()
                      throws java.lang.Exception
        This method is used to retrieve the data for the contract. Each method loads the necessary contract data. Loads data into the data bean when the DataBeanManager.activate() runs.
        Specified by:
        populate in interface com.ibm.commerce.beans.SmartDataBean
        Throws:
        java.lang.Exception
      • setCommandContext

        public void setCommandContext(com.ibm.commerce.command.CommandContext cc)
        Sets the command context.
        Specified by:
        setCommandContext in interface com.ibm.commerce.beans.SmartDataBean
        Parameters:
        cc - com.ibm.commerce.command.CommandContext
      • setRequestProperties

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