Package lumis.service.analytics.eventanalytics.bean

Class EventAnalyticsReport

  • All Implemented Interfaces:
    java.lang.Cloneable
    public class EventAnalyticsReport
extends java.lang.Object
implements java.lang.Cloneable
    An event analytics report.
    Since:
    11.0.0
    Version:
    $Revision: 26586 $ $Date: 2024-08-26 21:06:04 -0300 (Mon, 26 Aug 2024) $

    • Constructor Detail

      • EventAnalyticsReport

        public EventAnalyticsReport​(java.lang.String id)

    • Method Detail

      • getTitle

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

      • setTitle

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

      • getReportType

        public java.lang.String getReportType()
        Returns the reportType.
        Returns:
        the reportType
        Since:
        11.0.0

      • setReportType

        public EventAnalyticsReport setReportType​(java.lang.String reportType)
        Sets the reportType.
        Parameters:
        reportType - the reportType 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 EventAnalyticsReport 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 EventAnalyticsReport setTimeFrame​(java.lang.String timeFrame)
        Sets the timeFrame.
        Parameters:
        timeFrame - the timeFrame value to set.
        Since:
        11.0.0

      • getGroupBy

        public java.lang.String getGroupBy()
        Returns the groupBy.
        Returns:
        the groupBy
        Since:
        11.0.0

      • getParsedGroupBys

        public java.util.List<GroupBy> getParsedGroupBys()
                                          throws PortalException
        Returns the parsed group by list.
        Returns:
        the list of groupBy, or an empty list if there is no group by.
        Throws:
        PortalException
        Since:
        15.0.0

      • getParsedGroupBy

        public GroupBy getParsedGroupBy()
                         throws PortalException
        Returns the parsed groupBy. This method supports only scenarios without group by or with one group by. For scenarios where there may be multiple group by use getParsedGroupBys() instead.
        Returns:
        the groupby or null if there is no group by.
        Throws:
        java.lang.IllegalStateException - if there are multiple group by. In this scenario getParsedGroupBys() should be used instead.
        PortalException
        Since:
        14.0.0

      • setGroupBy

        public EventAnalyticsReport setGroupBy​(java.lang.String groupBy)
        Sets the groupBy.
        Parameters:
        groupBy - the groupBy value to set.
        Since:
        11.0.0

      • getMetrics

        public java.lang.String getMetrics()
        Returns the metrics.
        Returns:
        the metrics
        Since:
        11.0.0

      • getParsedMetrics

        public java.util.Collection<Metric> getParsedMetrics()
                                              throws PortalException
        Returns the parsed metrics.
        Returns:
        the parsed metrics
        Throws:
        PortalException
        Since:
        14.0.0

      • setMetrics

        public EventAnalyticsReport setMetrics​(java.lang.String metrics)
        Sets the metrics.
        Parameters:
        metrics - the metrics 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 EventAnalyticsReport setEventFilter​(java.lang.String eventFilter)
        Sets the eventFilter.
        Parameters:
        eventFilter - the eventFilter value to set.
        Since:
        11.0.0

      • getInterval

        public java.lang.String getInterval()
        Returns the interval.
        Returns:
        the interval
        Since:
        11.0.0

      • setInterval

        public EventAnalyticsReport setInterval​(java.lang.String interval)
        Sets the interval.
        Parameters:
        interval - the interval value to set.
        Since:
        11.0.0

      • getShowTotal

        public java.lang.Boolean getShowTotal()
        Returns the showTotal.
        Returns:
        the showTotal
        Since:
        11.0.0

      • setShowTotal

        public EventAnalyticsReport setShowTotal​(java.lang.Boolean showTotal)
        Sets the showTotal.
        Parameters:
        showTotal - the showTotal value to set.
        Since:
        11.0.0

      • getShowTable

        public java.lang.Boolean getShowTable()
        Returns the showTable.
        Returns:
        the showTable
        Since:
        11.0.0

      • setShowTable

        public EventAnalyticsReport setShowTable​(java.lang.Boolean showTable)
        Sets the showTable.
        Parameters:
        showTable - the showTable 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 EventAnalyticsReport setStandard​(boolean isStandard)
        Sets the isStandard.
        Parameters:
        isStandard - the isStandard value to set.
        Since:
        11.0.0

      • getPosition

        public int getPosition()
        Returns the position.
        Returns:
        the position
        Since:
        11.0.0

      • setPosition

        public EventAnalyticsReport setPosition​(int position)
        Sets the position.
        Parameters:
        position - the position value to set.
        Since:
        11.0.0

      • getInstances

        public java.util.Collection<EventAnalyticsReportDashboard> getInstances()
        Gets all the report dashboards.
        Returns:
        all the report dashboards.
        Since:
        11.0.0

      • isHideLabels

        public java.lang.Boolean isHideLabels()
        Returns the hideLabels.
        Returns:
        the hideLabels
        Since:
        11.0.0

      • setHideLabels

        public EventAnalyticsReport setHideLabels​(java.lang.Boolean hideLabels)
        Sets the hideLabels.
        Parameters:
        hideLabels - the hideLabels value to set.
        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

      • getCompareWithType

        public java.lang.String getCompareWithType()
        Returns the compareWithType.
        Returns:
        the compareWithType
        Since:
        12.1.0

      • setCompareWithType

        public EventAnalyticsReport setCompareWithType​(java.lang.String compareWithType)
        Sets the compareWithType.
        Parameters:
        compareWithType - the compareWithType value to set.
        Since:
        12.1.0

      • getCompareWithAmount

        public java.lang.Integer getCompareWithAmount()
        Returns the compareWithAmount.
        Returns:
        the compareWithAmount
        Since:
        12.1.0

      • setCompareWithAmount

        public EventAnalyticsReport setCompareWithAmount​(java.lang.Integer compareWithAmount)
        Sets the compareWithAmount.
        Parameters:
        compareWithAmount - the compareWithAmount value to set.
        Since:
        12.1.0

      • getHideAxisLabels

        public java.lang.Boolean getHideAxisLabels()
        Returns the hideAxisLabels.
        Returns:
        the hideAxisLabels
        Since:
        12.1.0

      • setHideAxisLabels

        public EventAnalyticsReport setHideAxisLabels​(java.lang.Boolean hideAxisLabels)
        Sets the hideAxisLabels.
        Parameters:
        hideAxisLabels - the hideAxisLabels value to set.
        Since:
        12.1.0

      • clone

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

      • getShowAbandoned

        public boolean getShowAbandoned()
        Returns the showAbandoned.
        Returns:
        the showAbandoned
        Since:
        12.2.0

      • setShowAbandoned

        public EventAnalyticsReport setShowAbandoned​(java.lang.Boolean showAbandoned)
        Sets the showAbandoned.
        Parameters:
        showAbandoned - the showAbandoned value to set.
        Since:
        12.2.0

      • isEnableRest

        public boolean isEnableRest()
        Returns the enableRest.
        Returns:
        the enableRest
        Since:
        12.2.0

      • setEnableRest

        public EventAnalyticsReport setEnableRest​(boolean enableRest)
        Sets the enableRest.
        Parameters:
        enableRest - the enableRest value to set.
        Since:
        12.2.0

      • isRestFilterMonitorUserId

        public boolean isRestFilterMonitorUserId()
        Returns the restFilterMonitorUserId.
        Returns:
        the restFilterMonitorUserId
        Since:
        12.2.0

      • setRestFilterMonitorUserId

        public EventAnalyticsReport setRestFilterMonitorUserId​(boolean restFilterMonitorUserId)
        Sets the restFilterMonitorUserId.
        Parameters:
        restFilterMonitorUserId - the restFilterMonitorUserId value to set.
        Since:
        12.2.0

      • isRestFilterLumisUserId

        public boolean isRestFilterLumisUserId()
        Returns the restFilterLumisUserId.
        Returns:
        the restFilterLumisUserId
        Since:
        12.2.0

      • setRestFilterLumisUserId

        public EventAnalyticsReport setRestFilterLumisUserId​(boolean restFilterLumisUserId)
        Sets the restFilterLumisUserId.
        Parameters:
        restFilterLumisUserId - the restFilterLumisUserId value to set.
        Since:
        12.2.0

      • getRestFriendlyId

        public java.lang.String getRestFriendlyId()
        Returns the restFriendlyId.
        Returns:
        the restFriendlyId
        Since:
        12.2.0

      • setRestFriendlyId

        public EventAnalyticsReport setRestFriendlyId​(java.lang.String restFriendlyId)
        Sets the restFriendlyId.
        Parameters:
        restFriendlyId - the restFriendlyId value to set.
        Since:
        12.2.0

      • isRestFilterProjectId

        public boolean isRestFilterProjectId()
        Returns whether this report should demand a filter for project identifier when accessed through the REST interface.
        Returns:
        whether this report should demand a filter for project identifier when accessed through the REST interface.
        Since:
        14.0.0

      • setRestFilterProjectId

        public EventAnalyticsReport setRestFilterProjectId​(boolean restFilterProjectId)
        Sets whether this report should demand a filter for project identifier when accessed through the REST interface.
        Parameters:
        restFilterProjectId -
        Returns:
        this report for chaining commands
        Since:
        14.0.0

      • getCacheExpiration

        public int getCacheExpiration()
        Returns the cache expiration.
        Returns:
        the cache expiration.
        Since:
        14.0.0

      • setCacheExpiration

        public EventAnalyticsReport setCacheExpiration​(int cacheExpiration)
        Sets the cache expiration.
        Parameters:
        cacheExpiration - the cache expiration
        Returns:
        this report for chaining commands
        Since:
        14.0.0

      • isCompareValuesWithGreatestValue

        public boolean isCompareValuesWithGreatestValue()
        Returns whether the aggregation values must be compared with the greater one.
        Returns:
        whether the aggregation values must be compared with the greater one.
        Since:
        14.2.0

      • setCompareValuesWithGreatestValue

        public EventAnalyticsReport setCompareValuesWithGreatestValue​(boolean compareValuesWithGreatestValue)
        Sets whether the aggregation values must be compared with the greater one.
        Parameters:
        compareValuesWithGreatestValue - indicates whether the aggregation values must be compared with the greater one.
        Returns:
        this report for chaining commands
        Since:
        14.2.0

      • isExcludeAdminAreaAccess

        public boolean isExcludeAdminAreaAccess()
        Returns whether the values ​​of administrative areas should be excluded
        Returns:
        whether the values ​​of administrative areas should be excluded
        Since:
        17.0.0

      • setExcludeAdminAreaAccess

        public EventAnalyticsReport setExcludeAdminAreaAccess​(boolean excludeAdminAreaAccess)
        Sets whether the values of administrative areas should be excluded.
        Parameters:
        excludeAdminAreaAccess - indicates whether the values of administrative areas should be excluded.
        Returns:
        this report for chaining commands.
        Since:
        17.0.0

      • clearCustomCaches

        public void clearCustomCaches()
        Clears custom caches that depend on this report instance.
        Since:
        14.0.0