lumis.service.analytics.usersegmentation.bean

Class UserSegmentation

java.lang.Object

lumis.service.analytics.usersegmentation.bean.UserSegmentation

All Implemented Interfaces:

IUserSegmentation, IUserSegmentationSPI

public class UserSegmentation
extends Object
implements IUserSegmentationSPI

Represents a saved user segmentation.

Since:

11.1.0

Version:

$Revision: 23535 $ $Date: 2020-01-14 16:18:39 +0000 (Tue, 14 Jan 2020) $

Field Summary

Fields

Modifier and Type	Field and Description
static String	QUERY_BY_GROUP Named query that finds the instance of a given group.
static String	QUERY_BY_JOURNEY_STAGE Named query that finds the instance of a given journey stage.
static String	QUERY_BY_NEXT_MEMBERS_GENERATION Named query that finds the instances of a given service instance that match a given name.
static String	QUERY_BY_SERVICE_INSTANCE Named query that finds the instances of a given service instance.
static String	QUERY_BY_SERVICE_INSTANCE_AND_LIKE_NAME Named query that finds the instances of a given service instance that match a given name.
static String	QUERY_BY_SERVICE_INSTANCE_AND_NAME Named query that finds the instance of a given service instance with a given name.

Constructor Summary

Constructors

Constructor and Description
UserSegmentation() Default constructor.
UserSegmentation(JourneyStage stage) Creates a new segmentation for the given journey stage (identifier).

Method Summary

Modifier and Type	Method and Description
Collection<EventAnalyticsDashboard>	getDashboards() Get dashboards that have this User Segementation.
String	getId() Returns the id.
long	getMembershipCacheExpirationMillis() Returns the member cache expiration in milliseconds.
String	getName() Returns the name.
Date	getNextMembersGeneration() Returns the next members generation.
Collection<EventAnalyticsReport>	getReports() Get reports that have this User Segementation.
org.json.JSONObject	getSegmentationFilter() Returns the segmentation filter.
String	getServiceInstanceId() Returns the service instance identifier.
boolean	isJourneyStageSegmentation() Returns whether this is an automatically created segmentation for a journey stage.
void	setId(String id) Sets the id.
void	setName(String name) Sets the name.
void	setNextMembersGeneration(Date nextMembersGeneration) Sets the next members generation.
void	setSegmentationFilter(org.json.JSONObject segmentationFilter) Sets the segmentation filter.
void	setServiceInstanceId(String serviceInstanceId) Sets the service instance identifier.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

QUERY_BY_SERVICE_INSTANCE

public static final String QUERY_BY_SERVICE_INSTANCE

Named query that finds the instances of a given service instance. Requires the parameter si (service instance id) and returns multiple instances.

Since:

11.1.0

See Also:

Constant Field Values

QUERY_BY_SERVICE_INSTANCE_AND_NAME

public static final String QUERY_BY_SERVICE_INSTANCE_AND_NAME

Named query that finds the instance of a given service instance with a given name. Requires the parameters si (service instance id) and name (segmentation name) and returns a single instance.

Since:

11.1.0

See Also:

Constant Field Values

QUERY_BY_SERVICE_INSTANCE_AND_LIKE_NAME

public static final String QUERY_BY_SERVICE_INSTANCE_AND_LIKE_NAME

Named query that finds the instances of a given service instance that match a given name. Requires the parameters si (service instance id) and name (segmentation name).

Since:

11.1.0

See Also:

Constant Field Values

QUERY_BY_NEXT_MEMBERS_GENERATION

public static final String QUERY_BY_NEXT_MEMBERS_GENERATION

Named query that finds the instances of a given service instance that match a given name. Requires the parameters si (service instance id) and name (segmentation name).

Since:

11.2.0

See Also:

Constant Field Values

QUERY_BY_GROUP

public static final String QUERY_BY_GROUP

Named query that finds the instance of a given group. Requires the parameters groupId (group id) and returns a single instance.

Since:

11.1.0

See Also:

Constant Field Values

QUERY_BY_JOURNEY_STAGE

public static final String QUERY_BY_JOURNEY_STAGE

Named query that finds the instance of a given journey stage. Requires the parameter stageId (stage id) and returns a single instance.

Since:

12.2.0

See Also:

Constant Field Values

Constructor Detail

UserSegmentation

public UserSegmentation()

Default constructor.

Since:

12.2.0

UserSegmentation

public UserSegmentation(JourneyStage stage)
                 throws PortalException

Creates a new segmentation for the given journey stage (identifier).

Parameters:

stage - the journey stage identifier.

Throws:

PortalException

Since:

12.2.0

Method Detail

getName

public String getName()

Returns the name.

Specified by:

getName in interface IUserSegmentation

Returns:

the name

Since:

11.1.0

setName

public void setName(String name)

Sets the name.

Parameters:

name - the name value to set.

Since:

11.1.0

getServiceInstanceId

public String getServiceInstanceId()

Returns the service instance identifier.

Specified by:

getServiceInstanceId in interface IUserSegmentation

Returns:

the service instance identifier

Since:

11.1.0

setServiceInstanceId

public void setServiceInstanceId(String serviceInstanceId)

Sets the service instance identifier.

Parameters:

serviceInstanceId - the service instance identifier value to set.

Since:

11.1.0

getSegmentationFilter

public org.json.JSONObject getSegmentationFilter()

Returns the segmentation filter.

Returns:

the segmentation filter

Since:

11.1.0

setSegmentationFilter

public void setSegmentationFilter(org.json.JSONObject segmentationFilter)

Sets the segmentation filter.

Parameters:

segmentationFilter - the segmentation filter value to set.

Since:

11.1.0

getId

public String getId()

Returns the id.

Specified by:

getId in interface IUserSegmentation

Returns:

the id

Since:

11.1.0

setId

public void setId(String id)

Sets the id.

Parameters:

id - the id.

Since:

11.2.0

getReports

public Collection<EventAnalyticsReport> getReports()

Get reports that have this User Segementation.

Returns:

the reports;

Since:

11.1.0

getDashboards

public Collection<EventAnalyticsDashboard> getDashboards()

Get dashboards that have this User Segementation.

Returns:

the dashboards.

Since:

11.1.0

getMembershipCacheExpirationMillis

public long getMembershipCacheExpirationMillis()

Description copied from interface: IUserSegmentationSPI

Returns the member cache expiration in milliseconds.

Specified by:

getMembershipCacheExpirationMillis in interface IUserSegmentationSPI

Returns:

the member cache expiration in milliseconds.

getNextMembersGeneration

public Date getNextMembersGeneration()

Description copied from interface: IUserSegmentationSPI

Returns the next members generation.

Specified by:

getNextMembersGeneration in interface IUserSegmentationSPI

Returns:

the next members generation.

setNextMembersGeneration

public void setNextMembersGeneration(Date nextMembersGeneration)

Description copied from interface: IUserSegmentationSPI

Sets the next members generation.

Specified by:

setNextMembersGeneration in interface IUserSegmentationSPI

Parameters:

nextMembersGeneration - the next members generation.

isJourneyStageSegmentation

public boolean isJourneyStageSegmentation()

Description copied from interface: IUserSegmentationSPI

Returns whether this is an automatically created segmentation for a journey stage.

Specified by:

isJourneyStageSegmentation in interface IUserSegmentationSPI

Returns:

whether this is an automatically created segmentation for a journey stage.