Package lumis.service.analytics.eventanalytics.bean

Class EventAnalyticsDashboard

  • All Implemented Interfaces:
    java.lang.Cloneable
    public class EventAnalyticsDashboard
extends java.lang.Object
implements java.lang.Cloneable
    An event analytics dashboard.
    Since:
    11.0.0
    Version:
    $Revision: 26318 $ $Date: 2024-04-11 16:45:43 -0300 (Thu, 11 Apr 2024) $

    • Field Detail

      • NAMED_QUERY_FIND_BY_SERVICE_INSTANCE_IDS

        public static final java.lang.String NAMED_QUERY_FIND_BY_SERVICE_INSTANCE_IDS
        See Also:
        Constant Field Values

      • NAMED_QUERY_FIND_BY_PARENT_TEMPLATE_IDS

        public static final java.lang.String NAMED_QUERY_FIND_BY_PARENT_TEMPLATE_IDS
        See Also:
        Constant Field Values

    • Constructor Detail

      • EventAnalyticsDashboard

        public EventAnalyticsDashboard​(java.lang.String id)

    • Method Detail

      • getTitle

        public java.lang.String getTitle()
        Returns the title.
        Returns:
        the title
        Since:
        11.0.0

      • setTitle

        public EventAnalyticsDashboard setTitle​(java.lang.String title)
        Sets the title.
        Parameters:
        title - the title value to set.
        Since:
        11.0.0

      • getType

        public java.lang.String getType()
        Returns the type.
        Returns:
        the type
        Since:
        11.0.0

      • setType

        public EventAnalyticsDashboard setType​(java.lang.String type)
        Sets the type.
        Parameters:
        type - the type value to set.
        Since:
        11.0.0

      • getPosition

        public java.lang.Integer getPosition()
        Returns the position.
        Returns:
        the position
        Since:
        11.0.0

      • setPosition

        public EventAnalyticsDashboard setPosition​(java.lang.Integer position)
        Sets the position.
        Parameters:
        position - the position value to set.
        Since:
        11.0.0

      • getUserSegmentation

        public java.lang.String getUserSegmentation()
        Returns the userSegmentation.
        Returns:
        the userSegmentation
        Since:
        11.0.0

      • setUserSegmentation

        public EventAnalyticsDashboard setUserSegmentation​(java.lang.String userSegmentation)
        Sets the userSegmentation.
        Parameters:
        userSegmentation - the userSegmentation value to set.
        Since:
        11.0.0

      • getTimeFrame

        public java.lang.String getTimeFrame()
        Returns the timeFrame.
        Returns:
        the timeFrame
        Since:
        11.0.0

      • setTimeFrame

        public EventAnalyticsDashboard setTimeFrame​(java.lang.String timeFrame)
        Sets the timeFrame.
        Parameters:
        timeFrame - the timeFrame value to set.
        Since:
        11.0.0

      • getEventFilter

        public java.lang.String getEventFilter()
        Returns the eventFilter.
        Returns:
        the eventFilter
        Since:
        11.0.0

      • setEventFilter

        public void setEventFilter​(java.lang.String eventFilter)
        Sets the eventFilter.
        Parameters:
        eventFilter - the eventFilter value to set.
        Since:
        11.0.0

      • getId

        public java.lang.String getId()
        Returns the id.
        Returns:
        the id
        Since:
        11.0.0

      • isStandard

        public boolean isStandard()
        Returns the isStandard.
        Returns:
        the isStandard
        Since:
        11.0.0

      • setStandard

        public EventAnalyticsDashboard setStandard​(boolean isStandard)
        Sets the isStandard.
        Parameters:
        isStandard - the isStandard value to set.
        Since:
        11.0.0

      • getInstances

        public java.util.List<EventAnalyticsReportDashboard> getInstances()
        Get all the dashboard reports.
        Returns:
        all the dashboard reports.
        Since:
        11.0.0

      • getReportsToBeUsed

        public java.util.List<EventAnalyticsReportDashboard> getReportsToBeUsed()
                                                                 throws PortalException
        Returns the reports to be used when accessing the dashboard. Unlike getInstances(), it checks whether the dashboard is a standard one and, if so, it reads the reports to be used from standard JSON.
        Returns:
        the reports to be used when accessing the dashboard.
        Throws:
        PortalException
        Since:
        14.0.0

      • addReport

        public EventAnalyticsDashboard addReport​(EventAnalyticsReport report,
                                         int position)
        Add a report to this dashboard.
        Parameters:
        report - the report.
        position - the position.
        Returns:
        this dashboard.
        Since:
        11.0.0

      • clearReports

        public EventAnalyticsDashboard clearReports()
        Completely erases the reports of this dashboard.
        Returns:
        this dashboard.
        Since:
        11.0.0

      • getUserSegmentationRef

        public UserSegmentation getUserSegmentationRef()
        Returns the user segmentation reference.
        Returns:
        the user segmentation reference
        Since:
        11.1.0

      • setUserSegmentationRef

        public void setUserSegmentationRef​(UserSegmentation userSegmentationRef)
        Sets the user segmentation reference.
        Parameters:
        userSegmentationRef - the user segmentation reference value to set.
        Since:
        11.1.0

      • isShared

        public boolean isShared()
        Returns whether this dashboard should be shared.
        Returns:
        whether this dashboard should be shared.
        Since:
        14.0.0

      • setShared

        public EventAnalyticsDashboard setShared​(boolean shared)
        Sets whether this dashboard should be shared.
        Parameters:
        isShared - whether this dashboard should be shared.
        Since:
        14.0.0

      • getEmailTargets

        public java.lang.String getEmailTargets()
        Returns the emailTargets.
        Returns:
        the emailTargets
        Since:
        14.0.0

      • setEmailTargets

        public EventAnalyticsDashboard setEmailTargets​(java.lang.String emailTargets)
        Sets the emailTargets.
        Parameters:
        emailTargets - the emailTargets value to set.
        Since:
        14.0.0

      • getEmailTime

        public java.lang.Integer getEmailTime()
        Returns the emailTime.
        Returns:
        the emailTime
        Since:
        14.0.0

      • setEmailTime

        public EventAnalyticsDashboard setEmailTime​(java.lang.Integer emailTime)
        Sets the emailTime.
        Parameters:
        emailTime - the emailTime value to set.
        Since:
        14.0.0

      • getEmailWeekday

        public java.lang.Integer getEmailWeekday()
        Returns the emailWeekday.
        Returns:
        the emailWeekday
        Since:
        14.0.0

      • setEmailWeekday

        public EventAnalyticsDashboard setEmailWeekday​(java.lang.Integer emailWeekday)
        Sets the emailWeekday.
        Parameters:
        emailWeekday - the emailWeekday value to set.
        Since:
        14.0.0

      • getEmailNextDateToSend

        public java.util.Date getEmailNextDateToSend()
        Returns the emailNextDateToSend.
        Returns:
        the emailNextDateToSend
        Since:
        14.0.0

      • setEmailNextDateToSend

        public EventAnalyticsDashboard setEmailNextDateToSend​(java.util.Date emailNextDateToSend)
        Sets the emailNextDateToSend.
        Parameters:
        emailNextDateToSend - the emailNextDateToSend value to set.
        Since:
        14.0.0

      • getParentTemplate

        public EventAnalyticsDashboard getParentTemplate()
        Returns the parent template (if any).
        Returns:
        the parent template (if any).
        Since:
        14.1.0

      • getContentVersion

        public ContentVersion getContentVersion()
        Returns the content version of this dashboard.
        Returns:
        the content version of this dashboard.
        Since:
        14.1.0

      • isABTPerformanceDashboard

        public boolean isABTPerformanceDashboard()
        Returns whether this is an ABTest performance dashboard.
        Returns:
        the isABTPerformanceDashboard value.
        Since:
        16.0.0

      • setABTPerformanceDashboard

        public EventAnalyticsDashboard setABTPerformanceDashboard​(boolean isABTPerformanceDashboard)
        Sets whether this is an ABTest performance dashboard.
        Parameters:
        isABTPerformanceDashboard - the value to be set.
        Since:
        16.0.0

      • isContentPerformanceDashboard

        public boolean isContentPerformanceDashboard()
        Return the value of isContentPerformanceDashboard
        Returns:
        boolean
        Since:
        16.0.0

      • setContentPerformanceDashboard

        public EventAnalyticsDashboard setContentPerformanceDashboard​(boolean isContentPerformanceDashboard)
        Set value for isContentPerformanceDashboard
        Parameters:
        isContentPerformanceDashboard -
        Since:
        16.0.0

      • clone

        public EventAnalyticsDashboard clone()
                              throws java.lang.CloneNotSupportedException
        Overrides:
        clone in class java.lang.Object
        Throws:
        java.lang.CloneNotSupportedException