java.lang.Object
- lumis.service.analytics.usersegmentation.bean.UserSegmentation

All Implemented Interfaces:

IUserSegmentation, IUserSegmentationSPI
```
public class UserSegmentation
extends java.lang.Object
implements IUserSegmentationSPI
```
Represents a saved user segmentation.

Since:

11.1.0

Version:

$Revision$ $Date$

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`QUERY_ALL`	Named query that finds all instances of user segmentations.
`static java.lang.String`	`QUERY_BY_GROUP`	Named query that finds the instance of a given group.
`static java.lang.String`	`QUERY_BY_JOURNEY_STAGE`	Named query that finds the instance of a given journey stage.
`static java.lang.String`	`QUERY_BY_NEXT_MEMBERS_GENERATION`	Named query that finds the instances of a given service instance that match a given name.
`static java.lang.String`	`QUERY_BY_SERVICE_INSTANCE`	Named query that finds the instances of a given service instance.
`static java.lang.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 java.lang.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 Description

UserSegmentation()
Default constructor.

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.util.Collection<EventAnalyticsDashboard>`	`getDashboards()`	Get dashboards that have this User Segementation.
`java.lang.String`	`getId()`	Returns the id.
`long`	`getMembershipCacheExpirationMillis()`	Returns the member cache expiration in milliseconds.
`java.lang.String`	`getName()`	Returns the name.
`java.util.Date`	`getNextMembersGeneration()`	Returns the next members generation.
`java.util.Collection<EventAnalyticsReport>`	`getReports()`	Get reports that have this User Segementation.
`org.json.JSONObject`	`getSegmentationFilter()`	Returns the segmentation filter.
`java.lang.String`	`getServiceInstanceId()`	Returns the service instance identifier.
`UserSegmentationData`	`getUserSegmentationData()`	Returns the user segmentation data.
`boolean`	`isJourneyStageSegmentation()`	Returns whether this is an automatically created segmentation for a journey stage.
`void`	`setId(java.lang.String id)`	Sets the id.
`void`	`setName(java.lang.String name)`	Sets the name.
`void`	`setNextMembersGeneration(java.util.Date nextMembersGeneration)`	Sets the next members generation.
`void`	`setSegmentationFilter(org.json.JSONObject segmentationFilter)`	Sets the segmentation filter.
`void`	`setServiceInstanceId(java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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
  - QUERY_ALL
```
public static final java.lang.String QUERY_ALL
```
    Named query that finds all instances of user segmentations.
    
    Since:
    
    17.0.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 java.lang.String getName()
```
    Returns the name.
    
    Specified by:
    
    getName in interface IUserSegmentation
    
    Returns:
    
    the name
    
    Since:
    
    11.1.0
  - setName
```
public void setName(java.lang.String name)
```
    Sets the name.
    
    Parameters:
    
    name - the name value to set.
    
    Since:
    
    11.1.0
  - getServiceInstanceId
```
public java.lang.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(java.lang.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
  - getUserSegmentationData
```
public UserSegmentationData getUserSegmentationData()
                                             throws PortalException
```
    Returns the user segmentation data.
    
    Returns:
    
    the user segmentation data
    
    Throws:
    
    PortalException
    
    Since:
    
    17.0.0
  - getId
```
public java.lang.String getId()
```
    Returns the id.
    
    Specified by:
    
    getId in interface IUserSegmentation
    
    Returns:
    
    the id
    
    Since:
    
    11.1.0
  - setId
```
public void setId(java.lang.String id)
```
    Sets the id.
    
    Parameters:
    
    id - the id.
    
    Since:
    
    11.2.0
  - getReports
```
public java.util.Collection<EventAnalyticsReport> getReports()
```
    Get reports that have this User Segementation.
    
    Returns:
    
    the reports;
    
    Since:
    
    11.1.0
  - getDashboards
```
public java.util.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 java.util.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(java.util.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.

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

Class UserSegmentation

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

QUERY_BY_SERVICE_INSTANCE

QUERY_BY_SERVICE_INSTANCE_AND_NAME

QUERY_BY_SERVICE_INSTANCE_AND_LIKE_NAME

QUERY_BY_NEXT_MEMBERS_GENERATION

QUERY_BY_GROUP

QUERY_BY_JOURNEY_STAGE

QUERY_ALL

Constructor Detail

UserSegmentation

UserSegmentation

Method Detail

getName

setName

getServiceInstanceId

setServiceInstanceId

getSegmentationFilter

setSegmentationFilter

getUserSegmentationData

getId

setId

getReports

getDashboards

getMembershipCacheExpirationMillis

getNextMembersGeneration

setNextMembersGeneration

isJourneyStageSegmentation