lumis.service.analytics.eventanalytics.bean

Class EventAnalyticsDashboard

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: 24009 $ $Date: 2020-08-07 14:28:43 +0000 (Fri, 07 Aug 2020) $

Constructor Summary

Constructors

Constructor and Description
EventAnalyticsDashboard(String id)

Method Summary

Modifier and Type	Method and 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()
String	getEventFilter() Returns the eventFilter.
String	getId() Returns the id.
Collection<EventAnalyticsReportDashboard>	getInstances() Get all the dashboard reports.
Integer	getPosition() Returns the position.
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.
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

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

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:

%LUM_NEXT_VERSION%

setShared

public EventAnalyticsDashboard setShared(boolean shared)

Sets whether this dashboard should be shared.

Parameters:

isShared - whether this dashboard should be shared.

Since:

%LUM_NEXT_VERSION%

clone

public EventAnalyticsDashboard clone()
                              throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException