Class EventAnalyticsDashboard

  • All Implemented Interfaces:
    Cloneable

    public class EventAnalyticsDashboard
    extends Object
    implements Cloneable
    An event analytics dashboard.
    Since:
    11.0.0
    Version:
    $Revision: 24684 $ $Date: 2021-08-23 18:58:35 -0300 (Mon, 23 Aug 2021) $
    • Field Detail

      • NAMED_QUERY_FIND_BY_SERVICE_INSTANCE_IDS

        public static final String NAMED_QUERY_FIND_BY_SERVICE_INSTANCE_IDS
        See Also:
        Constant Field Values
      • NAMED_QUERY_FIND_BY_PARENT_TEMPLATE_IDS

        public static final String NAMED_QUERY_FIND_BY_PARENT_TEMPLATE_IDS
        See Also:
        Constant Field Values
    • Constructor Detail

      • EventAnalyticsDashboard

        public EventAnalyticsDashboard​(String id)
    • Method Detail

      • getTitle

        public String getTitle()
        Returns the title.
        Returns:
        the title
        Since:
        11.0.0
      • getType

        public String getType()
        Returns the type.
        Returns:
        the type
        Since:
        11.0.0
      • getPosition

        public Integer getPosition()
        Returns the position.
        Returns:
        the position
        Since:
        11.0.0
      • setPosition

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

        public String getUserSegmentation()
        Returns the userSegmentation.
        Returns:
        the userSegmentation
        Since:
        11.0.0
      • setUserSegmentation

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

        public String getTimeFrame()
        Returns the timeFrame.
        Returns:
        the timeFrame
        Since:
        11.0.0
      • setTimeFrame

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

        public String getEventFilter()
        Returns the eventFilter.
        Returns:
        the eventFilter
        Since:
        11.0.0
      • setEventFilter

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

        public 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
      • 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 String getEmailTargets()
        Returns the emailTargets.
        Returns:
        the emailTargets
        Since:
        14.0.0
      • setEmailTargets

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

        public Integer getEmailTime()
        Returns the emailTime.
        Returns:
        the emailTime
        Since:
        14.0.0
      • setEmailTime

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

        public Integer getEmailWeekday()
        Returns the emailWeekday.
        Returns:
        the emailWeekday
        Since:
        14.0.0
      • setEmailWeekday

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

        public Date getEmailNextDateToSend()
        Returns the emailNextDateToSend.
        Returns:
        the emailNextDateToSend
        Since:
        14.0.0
      • setEmailNextDateToSend

        public EventAnalyticsDashboard setEmailNextDateToSend​(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