java.lang.Object
- lumis.service.analytics.eventanalytics.bean.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) $

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class EventAnalyticsDashboard.EmailType

Field Summary

Fields
Modifier and Type Field Description

static String NAMED_QUERY_FIND_BY_PARENT_TEMPLATE_IDS

static String NAMED_QUERY_FIND_BY_SERVICE_INSTANCE_IDS

Constructor Summary

Constructors
Constructor Description

EventAnalyticsDashboard(String id)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`EventAnalyticsDashboard`	`addReport(EventAnalyticsReport report)`	Adds a report to the dashboard.
`EventAnalyticsDashboard`	`addReport(EventAnalyticsReport report, int position)`	Add a report to this dashboard.
`EventAnalyticsDashboard`	`addReport(EventAnalyticsReport report, int position, EventAnalyticsReportDashboard.Width width)`	Add a report to this dashboard.
`EventAnalyticsDashboard`	`clearReports()`	Completely erases the reports of this dashboard.
`EventAnalyticsDashboard`	`clone()`
`ContentVersion`	`getContentVersion()`	Returns the content version of this dashboard.
`Date`	`getEmailNextDateToSend()`	Returns the emailNextDateToSend.
`String`	`getEmailTargets()`	Returns the emailTargets.
`Integer`	`getEmailTime()`	Returns the emailTime.
`EventAnalyticsDashboard.EmailType`	`getEmailType()`	Returns the emailType.
`Integer`	`getEmailWeekday()`	Returns the emailWeekday.
`String`	`getEventFilter()`	Returns the eventFilter.
`String`	`getId()`	Returns the id.
`Collection<EventAnalyticsReportDashboard>`	`getInstances()`	Get all the dashboard reports.
`EventAnalyticsDashboard`	`getParentTemplate()`	Returns the parent template (if any).
`Integer`	`getPosition()`	Returns the position.
`Collection<EventAnalyticsReportDashboard>`	`getReportsToBeUsed()`	Returns the reports to be used when accessing the dashboard.
`String`	`getTimeFrame()`	Returns the timeFrame.
`String`	`getTitle()`	Returns the title.
`String`	`getType()`	Returns the type.
`String`	`getUserSegmentation()`	Returns the userSegmentation.
`UserSegmentation`	`getUserSegmentationRef()`	Returns the user segmentation reference.
`boolean`	`isShared()`	Returns whether this dashboard should be shared.
`boolean`	`isStandard()`	Returns the isStandard.
`EventAnalyticsDashboard`	`removeReport(EventAnalyticsReportDashboard instance)`	Removes a report from the dashboard.
`EventAnalyticsDashboard`	`setEmailNextDateToSend(Date emailNextDateToSend)`	Sets the emailNextDateToSend.
`EventAnalyticsDashboard`	`setEmailTargets(String emailTargets)`	Sets the emailTargets.
`EventAnalyticsDashboard`	`setEmailTime(Integer emailTime)`	Sets the emailTime.
`EventAnalyticsDashboard`	`setEmailType(EventAnalyticsDashboard.EmailType emailType)`	Sets the emailType.
`EventAnalyticsDashboard`	`setEmailWeekday(Integer emailWeekday)`	Sets the emailWeekday.
`void`	`setEventFilter(String eventFilter)`	Sets the eventFilter.
`EventAnalyticsDashboard`	`setPosition(Integer position)`	Sets the position.
`EventAnalyticsDashboard`	`setShared(boolean shared)`	Sets whether this dashboard should be shared.
`EventAnalyticsDashboard`	`setStandard(boolean isStandard)`	Sets the isStandard.
`EventAnalyticsDashboard`	`setTimeFrame(String timeFrame)`	Sets the timeFrame.
`EventAnalyticsDashboard`	`setTitle(String title)`	Sets the title.
`EventAnalyticsDashboard`	`setType(String type)`	Sets the type.
`EventAnalyticsDashboard`	`setUserSegmentation(String userSegmentation)`	Sets the userSegmentation.
`void`	`setUserSegmentationRef(UserSegmentation userSegmentationRef)`	Sets the user segmentation reference.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 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
  - setTitle
```
public EventAnalyticsDashboard setTitle(String title)
```
    Sets the title.
    
    Parameters:
    
    title - the title value to set.
    
    Since:
    
    11.0.0
  - getType
```
public String getType()
```
    Returns the type.
    
    Returns:
    
    the type
    
    Since:
    
    11.0.0
  - setType
```
public EventAnalyticsDashboard setType(String type)
```
    Sets the type.
    
    Parameters:
    
    type - the type value to set.
    
    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
  - getInstances
```
public Collection<EventAnalyticsReportDashboard> getInstances()
```
    Get all the dashboard reports.
    
    Returns:
    
    all the dashboard reports.
    
    Since:
    
    11.0.0
  - getReportsToBeUsed
```
public Collection<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)
```
    Adds a report to the dashboard.
    
    Parameters:
    
    report - the report to be added.
    
    Returns:
    
    the dashboard.
    
    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
  - addReport
```
public EventAnalyticsDashboard addReport(EventAnalyticsReport report,
                                         int position,
                                         EventAnalyticsReportDashboard.Width width)
```
    Add a report to this dashboard.
    
    Parameters:
    
    report - the report.
    
    position - the position.
    
    width - the width.
    
    Returns:
    
    this dashboard.
    
    Since:
    
    11.0.0
  - removeReport
```
public EventAnalyticsDashboard removeReport(EventAnalyticsReportDashboard instance)
```
    Removes a report from the dashboard.
    
    Parameters:
    
    reportId - the report identifier to be removed.
    
    Returns:
    
    the 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
  - getEmailType
```
public EventAnalyticsDashboard.EmailType getEmailType()
```
    Returns the emailType.
    
    Returns:
    
    the emailType
    
    Since:
    
    14.0.0
  - setEmailType
```
public EventAnalyticsDashboard setEmailType(EventAnalyticsDashboard.EmailType emailType)
```
    Sets the emailType.
    
    Parameters:
    
    emailType - the emailType value to set.
    
    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
  - clone
```
public EventAnalyticsDashboard clone()
                              throws CloneNotSupportedException
```
    Overrides:
    
    clone in class Object
    
    Throws:
    
    CloneNotSupportedException

Modifier and Type	Field	Description
`static String`	`NAMED_QUERY_FIND_BY_PARENT_TEMPLATE_IDS`
`static String`	`NAMED_QUERY_FIND_BY_SERVICE_INSTANCE_IDS`

Class EventAnalyticsDashboard

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NAMED_QUERY_FIND_BY_SERVICE_INSTANCE_IDS

NAMED_QUERY_FIND_BY_PARENT_TEMPLATE_IDS

Constructor Detail

EventAnalyticsDashboard

Method Detail

getTitle

setTitle

getType

setType

getPosition

setPosition

getUserSegmentation

setUserSegmentation

getTimeFrame

setTimeFrame

getEventFilter

setEventFilter

getId

isStandard

setStandard

getInstances

getReportsToBeUsed

addReport

addReport

addReport

removeReport

clearReports

getUserSegmentationRef

setUserSegmentationRef

isShared

setShared

getEmailType

setEmailType

getEmailTargets

setEmailTargets

getEmailTime

setEmailTime

getEmailWeekday

setEmailWeekday

getEmailNextDateToSend

setEmailNextDateToSend

getParentTemplate

getContentVersion

clone