com.ibm.commerce.tools.segmentation

Class SegmentCache

  • java.lang.Object
    • com.ibm.commerce.tools.segmentation.SegmentCache


  • public final class SegmentCache
    extends java.lang.Object
    This class contains static methods that allow you to get a cached instance of a member group condition object.
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      IBM copyright notice field.
    • Constructor Summary

      Constructors 
      Constructor and Description
      SegmentCache() 
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method and Description
      static boolean getMarketingPopulates(java.lang.Long memberGroupOwnerId, java.lang.String memberGroupName)
      This method returns whether the Condition object for the specified member group has the marketing populates condition set.
      static boolean getOnlyHasMarketingPopulatesCondition(java.lang.Long memberGroupOwnerId, java.lang.String memberGroupName)
      This method returns whether the Condition object for the specified member group has only one condition, which is the marketing populates condition, and the condition is set to true.
      static Condition getSegmentCondition(java.lang.Long memberGroupOwnerId, java.lang.String memberGroupName)
      This method returns the Condition object for the specified member group.
      static java.util.Vector getSegmentExplicitlyExcludedMembers(java.lang.Long memberGroupOwnerId, java.lang.String memberGroupName)
      Gets a Vector object of all of the explicitly excluded members of the member group.
      static java.util.Vector getSegmentExplicitlyIncludedMembers(java.lang.Long memberGroupOwnerId, java.lang.String memberGroupName)
      Gets a Vector object of all of the explicitly included members of the member group.
      static void localRefresh()
      Perform refresh of local cache.
      static void refresh(CommandContext commandContext)
      Perform refresh of cache.
      • Methods inherited from class java.lang.Object

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

      • COPYRIGHT

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

      • SegmentCache

        public SegmentCache()
    • Method Detail

      • getSegmentCondition

        public static Condition getSegmentCondition(java.lang.Long memberGroupOwnerId,
                                                    java.lang.String memberGroupName)
        This method returns the Condition object for the specified member group.
        Parameters:
        memberGroupOwnerId - The member group owner ID.
        memberGroupName - The member group name.
        Returns:
        The Condition object for the member group.
      • getMarketingPopulates

        public static boolean getMarketingPopulates(java.lang.Long memberGroupOwnerId,
                                                    java.lang.String memberGroupName)
        This method returns whether the Condition object for the specified member group has the marketing populates condition set.
        Parameters:
        memberGroupOwnerId - The member group owner ID.
        memberGroupName - The member group name.
        Returns:
        true if the Segment has the marketing populates condition set, false otherwise.
      • getOnlyHasMarketingPopulatesCondition

        public static boolean getOnlyHasMarketingPopulatesCondition(java.lang.Long memberGroupOwnerId,
                                                                    java.lang.String memberGroupName)
        This method returns whether the Condition object for the specified member group has only one condition, which is the marketing populates condition, and the condition is set to true.
        Parameters:
        memberGroupOwnerId - The member group owner ID.
        memberGroupName - The member group name.
        Returns:
        true if the Segment has the marketing populates condition set to true and the marketing populates condition is the only condition in the segment.
      • getSegmentExplicitlyIncludedMembers

        public static java.util.Vector getSegmentExplicitlyIncludedMembers(java.lang.Long memberGroupOwnerId,
                                                                           java.lang.String memberGroupName)
        Gets a Vector object of all of the explicitly included members of the member group. This method is not used as it is not recommended to cache the included members in the in-memory segment cache. This has been replaced with a cache entry for the command MemberGroupsCacheCmdImpl to cache the member groups per member in dynacache.
        Parameters:
        memberGroupOwnerId - The member group owner ID.
        memberGroupName - The member group name.
        Returns:
        A Vector of explicitly included members.
      • getSegmentExplicitlyExcludedMembers

        public static java.util.Vector getSegmentExplicitlyExcludedMembers(java.lang.Long memberGroupOwnerId,
                                                                           java.lang.String memberGroupName)
        Gets a Vector object of all of the explicitly excluded members of the member group. This method is not used as it is not recommended to cache the excluded members in the in-memory segment cache. This has been replaced with a cache entry for the command MemberGroupsCacheCmdImpl to cache the member groups per member in dynacache.
        Parameters:
        memberGroupOwnerId - The member group owner ID.
        memberGroupName - The member group name.
        Returns:
        A Vector of explicitly included members.
      • localRefresh

        public static void localRefresh()
        Perform refresh of local cache.
      • refresh

        public static void refresh(CommandContext commandContext)
                            throws ECException
        Perform refresh of cache.
        Parameters:
        commandContext - The command context.
        Throws:
        ECException