com.ibm.commerce.tools.segmentation

Class SegmentListDataBean

  • All Implemented Interfaces:
    DataBean, InputDataBean, SmartDataBean, Delegator, Protectable, SegmentConstants, java.io.Serializable


    public class SegmentListDataBean
    extends SegmentListDataBeanBase
    implements SegmentConstants
    Lists member groups that are used for Customer Segments (Member Group Usage = General Purpose). The member groups returned are associated with the store in the command context. By default, store path is taken into consideration. If only the current store should be used, then setLocalSearch(true) should be called.

    1. Searching for all member groups of this usage, that are associated with the store in the command context. This is the default type of search.
    2. The same as #1 but with an additional qualifier on the member group name. This type of search is used when the member group name is not null. Additional search criteria may also be specified regarding the member group name:

      "1" - Match case, beginning with
      "2" - Match case, containing
      "3" - Ignore case, beginning with
      "4" - Ignore case, containing
      "5" - Match case, exact match
      "6" - Ignore case, exact match
      "7" - Ignore case, ends with
      If unspecified, the default search criteria is "4".
    See Also:
    Serialized Form
    • Field Detail

      • localSearch

        public boolean localSearch
        A flag that indicates whether the list data bean should list all segments that belong to stores on the store path.
    • Constructor Detail

      • SegmentListDataBean

        public SegmentListDataBean()
    • Method Detail

      • getLocalSearch

        public boolean getLocalSearch()
        Gets the value of the local search flag.
        Returns:
        True if search on current store only; false otherwise.
      • getSegmentList

        public SegmentDataBean[] getSegmentList()
        Gets an array of SegmentDataBean objects.
        Returns:
        An array of SegmentDataBean objects.
      • populate

        public void populate()
                      throws java.lang.Exception
        Populates the data bean.
        Specified by:
        populate in interface SmartDataBean
        Overrides:
        populate in class SmartDataBeanImpl
        Throws:
        java.lang.Exception - if an error occurs
      • setLocalSearch

        public void setLocalSearch(boolean newLocalSearch)
        Sets the local search flag, a true value will instruct the data bean to search for segments in the current store only; a false value will instruct the data bean to go up the store path and find all segments own by stores on the store path.
        Parameters:
        newLocalSearch - True if search on current store only; false otherwise.
      • setMemberGroupName

        public void setMemberGroupName(java.lang.String astrMemberGroupname)
        Sets the name of the member groups to find. By default the search criteria will be "Ignore case, containing". Other search criteria can be specified by calling setNameSearchCriteria().
        Parameters:
        astrMemberGroupname - The name of the member group to find.
      • setNameSearchCriteria

        public void setNameSearchCriteria(java.lang.String astrSearchCriteria)
        Sets the search criteria to be used with the member group name:
          "1" - Match case, beginning with
          "2" - Match case, containing
          "3" - Ignore case, beginning with
          "4" - Ignore case, containing
          "5" - Match case, exact match
          "6" - Ignore case, exact match
          "7" - Ignore case, ends with
        If unspecified, the default search criteria is "4".
        Parameters:
        astrSearchCriteria - The search criteria used when finding member groups by name.