Package lumis.service.analytics.usersegmentation.bean

Class UserSegmentation

  • All Implemented Interfaces:
    IUserSegmentation, IUserSegmentationSPI
    public class UserSegmentation
extends java.lang.Object
implements IUserSegmentationSPI
    Represents a saved user segmentation.
    Since:
    11.1.0
    Version:
    $Revision: 26586 $ $Date: 2024-08-26 21:06:04 -0300 (Mon, 26 Aug 2024) $

    • Field Detail

      • QUERY_BY_SERVICE_INSTANCE

        public static final java.lang.String QUERY_BY_SERVICE_INSTANCE
        Named query that finds the instances of a given service instance. Requires the parameter si (service instance id) and returns multiple instances.
        Since:
        11.1.0
        See Also:
        Constant Field Values

      • QUERY_BY_SERVICE_INSTANCE_AND_NAME

        public static final java.lang.String QUERY_BY_SERVICE_INSTANCE_AND_NAME
        Named query that finds the instance of a given service instance with a given name. Requires the parameters si (service instance id) and name (segmentation name) and returns a single instance.
        Since:
        11.1.0
        See Also:
        Constant Field Values

      • QUERY_BY_SERVICE_INSTANCE_AND_LIKE_NAME

        public static final java.lang.String QUERY_BY_SERVICE_INSTANCE_AND_LIKE_NAME
        Named query that finds the instances of a given service instance that match a given name. Requires the parameters si (service instance id) and name (segmentation name).
        Since:
        11.1.0
        See Also:
        Constant Field Values

      • QUERY_BY_NEXT_MEMBERS_GENERATION

        public static final java.lang.String QUERY_BY_NEXT_MEMBERS_GENERATION
        Named query that finds the instances of a given service instance that match a given name. Requires the parameters si (service instance id) and name (segmentation name).
        Since:
        11.2.0
        See Also:
        Constant Field Values

      • QUERY_BY_GROUP

        public static final java.lang.String QUERY_BY_GROUP
        Named query that finds the instance of a given group. Requires the parameters groupId (group id) and returns a single instance.
        Since:
        11.1.0
        See Also:
        Constant Field Values

      • QUERY_BY_JOURNEY_STAGE

        public static final java.lang.String QUERY_BY_JOURNEY_STAGE
        Named query that finds the instance of a given journey stage. Requires the parameter stageId (stage id) and returns a single instance.
        Since:
        12.2.0
        See Also:
        Constant Field Values

      • QUERY_ALL

        public static final java.lang.String QUERY_ALL
        Named query that finds all instances of user segmentations.
        Since:
        17.0.0
        See Also:
        Constant Field Values

    • Constructor Detail

      • UserSegmentation

        public UserSegmentation()
        Default constructor.
        Since:
        12.2.0

      • UserSegmentation

        public UserSegmentation​(JourneyStage stage)
                 throws PortalException
        Creates a new segmentation for the given journey stage (identifier).
        Parameters:
        stage - the journey stage identifier.
        Throws:
        PortalException
        Since:
        12.2.0

    • Method Detail

      • getName

        public java.lang.String getName()
        Returns the name.
        Specified by:
        getName in interface IUserSegmentation
        Returns:
        the name
        Since:
        11.1.0

      • setName

        public void setName​(java.lang.String name)
        Sets the name.
        Parameters:
        name - the name value to set.
        Since:
        11.1.0

      • getServiceInstanceId

        public java.lang.String getServiceInstanceId()
        Returns the service instance identifier.
        Specified by:
        getServiceInstanceId in interface IUserSegmentation
        Returns:
        the service instance identifier
        Since:
        11.1.0

      • setServiceInstanceId

        public void setServiceInstanceId​(java.lang.String serviceInstanceId)
        Sets the service instance identifier.
        Parameters:
        serviceInstanceId - the service instance identifier value to set.
        Since:
        11.1.0

      • getSegmentationFilter

        public org.json.JSONObject getSegmentationFilter()
        Returns the segmentation filter.
        Returns:
        the segmentation filter
        Since:
        11.1.0

      • setSegmentationFilter

        public void setSegmentationFilter​(org.json.JSONObject segmentationFilter)
        Sets the segmentation filter.
        Parameters:
        segmentationFilter - the segmentation filter value to set.
        Since:
        11.1.0

      • getId

        public java.lang.String getId()
        Returns the id.
        Specified by:
        getId in interface IUserSegmentation
        Returns:
        the id
        Since:
        11.1.0

      • setId

        public void setId​(java.lang.String id)
        Sets the id.
        Parameters:
        id - the id.
        Since:
        11.2.0

      • getReports

        public java.util.Collection<EventAnalyticsReport> getReports()
        Get reports that have this User Segementation.
        Returns:
        the reports;
        Since:
        11.1.0

      • getDashboards

        public java.util.Collection<EventAnalyticsDashboard> getDashboards()
        Get dashboards that have this User Segementation.
        Returns:
        the dashboards.
        Since:
        11.1.0

      • setNextMembersGeneration

        public void setNextMembersGeneration​(java.util.Date nextMembersGeneration)
        Description copied from interface: IUserSegmentationSPI
        Sets the next members generation.
        Specified by:
        setNextMembersGeneration in interface IUserSegmentationSPI
        Parameters:
        nextMembersGeneration - the next members generation.

      • isJourneyStageSegmentation

        public boolean isJourneyStageSegmentation()
        Description copied from interface: IUserSegmentationSPI
        Returns whether this is an automatically created segmentation for a journey stage.
        Specified by:
        isJourneyStageSegmentation in interface IUserSegmentationSPI
        Returns:
        whether this is an automatically created segmentation for a journey stage.