lumis.service.analytics.usersegmentation.manager

Class UserSegmentationManager

java.lang.Object

lumis.service.analytics.usersegmentation.manager.UserSegmentationManager

public class UserSegmentationManager
extends Object

Manager for user segmentations.

Since:

11.1.0

Version:

$Revision: 22203 $ $Date: 2018-12-17 18:01:28 +0000 (Mon, 17 Dec 2018) $

Constructor Summary

Constructors

Constructor and Description
UserSegmentationManager()

Method Summary

Modifier and Type	Method and Description
static void	clearSegmentationGroup(String groupId) When a group is removed, it must be removed from the segmentation as well.
static void	deleteSegmentations(Collection<String> ids, String serviceInstanceId) Delete the given segmentations.
static void	deleteSegmentationsByServiceInstanceId(String serviceInstanceId) Deletes all segmentations of the given service instance.
static List<UserSegmentation>	findByServiceInstanceAndLikeName(String name, String serviceInstanceId) Returns the segmentations of the given service instance that matches the given name parameter.
static UserSegmentation	getById(String id) Returns the segmentation with the given identifier or null if no segmentation exists with the given identifier.
static List<UserSegmentation>	getByServiceInstance(String serviceInstanceId) Returns the segmentations of the given service instance.
static String	saveSegmentation(String name, String serviceInstanceId, org.json.JSONObject segmentationFilter) Save the given segmentation and returns the identifier of the segmentation added or updated.
static String	saveSegmentation(String name, String serviceInstanceId, org.json.JSONObject segmentationFilter, TimeUnit groupCacheExpirationUnit, long groupCacheExpirationAmount) Save the given segmentation and returns the identifier of the segmentation added or updated.
static UserSegmentation	updateSegmentation(String id, String serviceInstanceId, org.json.JSONObject filter) Updates the given segmentation with the given filters.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserSegmentationManager

public UserSegmentationManager()

Method Detail

saveSegmentation

public static String saveSegmentation(String name,
                                      String serviceInstanceId,
                                      org.json.JSONObject segmentationFilter)
                               throws PortalException

Save the given segmentation and returns the identifier of the segmentation added or updated. The affected segmentation will not have an attached group.

Parameters:

name - the segmentation name.

serviceInstanceId - the service instance identifier.

segmentationFilter - the segmentation filter.

Returns:

the identifier of the segmentation added or updated.

Throws:

PortalException

Since:

11.1.0

saveSegmentation

public static String saveSegmentation(String name,
                                      String serviceInstanceId,
                                      org.json.JSONObject segmentationFilter,
                                      TimeUnit groupCacheExpirationUnit,
                                      long groupCacheExpirationAmount)
                               throws PortalException

Save the given segmentation and returns the identifier of the segmentation added or updated. The affected segmentation will have an attached group.

Parameters:

name - the segmentation name.

serviceInstanceId - the service instance identifier.

segmentationFilter - the segmentation filter.

groupCacheExpirationUnit - the attached group cache expiration unit. Must be one of TimeUnit.SECONDS, TimeUnit.MINUTES, TimeUnit.HOURS or TimeUnit.DAYS.

groupCacheExpirationAmount - the attached group cache expiration amount. Must be a positive number.

Returns:

the identifier of the segmentation added or updated.

Throws:

PortalException

Since:

11.1.0

updateSegmentation

public static UserSegmentation updateSegmentation(String id,
                                                  String serviceInstanceId,
                                                  org.json.JSONObject filter)
                                           throws PortalException

Updates the given segmentation with the given filters. Does not change anything about an attached group.

Parameters:

id - the segmentation identifier.

serviceInstanceId - the service instance identifier.

filter - the segmentation filter.

Returns:

updated entity.

Throws:

PortalException

Since:

11.1.0

deleteSegmentations

public static void deleteSegmentations(Collection<String> ids,
                                       String serviceInstanceId)
                                throws PortalException

Delete the given segmentations.

Parameters:

ids - the segmentation identifiers.

serviceInstanceId - the service instance identifier.

Throws:

PortalException

Since:

11.1.0

deleteSegmentationsByServiceInstanceId

public static void deleteSegmentationsByServiceInstanceId(String serviceInstanceId)
                                                   throws PortalException

Deletes all segmentations of the given service instance.

Parameters:

serviceInstanceId - the service instance identifier.

Throws:

PortalException

Since:

11.1.0

clearSegmentationGroup

public static void clearSegmentationGroup(String groupId)

When a group is removed, it must be removed from the segmentation as well.

Parameters:

groupId - the group identifier.

Since:

11.1.0

findByServiceInstanceAndLikeName

public static List<UserSegmentation> findByServiceInstanceAndLikeName(String name,
                                                                      String serviceInstanceId)
                                                               throws PortalException

Returns the segmentations of the given service instance that matches the given name parameter.

Parameters:

name - the segmentation name.

serviceInstanceId - the service instance identifier.

Returns:

the segmentations of the given service instance that matches the given name parameter.

Throws:

PortalException

Since:

11.1.0

getById

public static UserSegmentation getById(String id)

Returns the segmentation with the given identifier or null if no segmentation exists with the given identifier.

Parameters:

id - the segmentation identifier.

Returns:

the segmentation with the given identifier or null if no segmentation exists with the given identifier.

Since:

11.1.0

getByServiceInstance

public static List<UserSegmentation> getByServiceInstance(String serviceInstanceId)
                                                   throws PortalException

Returns the segmentations of the given service instance.

Parameters:

serviceInstanceId - the service instance identifier.

Returns:

the segmentations of the given service instance.

Throws:

PortalException

Since:

11.1.0