Package org.eclnt.ccee.usagevariants

Class UsageVariantManager

java.lang.Object

org.eclnt.ccee.usagevariants.UsageVariantManager

All Implemented Interfaces:

ICCEEConstants

public class UsageVariantManager
extends Object
implements ICCEEConstants

Object that manages runtime configuration data for an object of instance IExtractApply.

Example: IExtractApply is implemented for a grid, so that runtime configuration of a user (e.g. sequence of columns) can be configured. The UsageVariantManager instance manages certain variants of configuration data, stores the variants in persistent store and applies the configuration data.

The information is kept by "service type", "service id", "UserId" and "variantId". Service type and service id are passed by the program using the UsageVariantManager, ther user id is picked by interface UserAccessMgr, the variant id(s) are defined by the user at runtime.

Field Summary

Fields inherited from interface org.eclnt.ccee.ICCEEConstants

AND, ASC, AVG, BETWEEN, BRC, BRO, COUNT, DEFAULT_CONTEXT, DESC, FUNCTIONRESULT, GREATER, GREATEREQUAL, IN, IS, ISNOT, LIKE, LL_DBG, LL_ERR, LL_INF, LL_WAR, LOWER, LOWEREQUAL, MAX, MIN, NULL, OR, ORDERBY, QPFUNCTION_LOWER, QPFUNCTION_UPPER, SUM

Constructor Summary

Constructors

Constructor	Description
UsageVariantManager(String serviceType, String serviceId, org.eclnt.util.extractapply.IExtractApply service)

Method Summary

Modifier and Type	Method	Description
void	activate(boolean applyDefaultVariant)
void	applyCurrentVariant()
boolean	checkIfVariantContainsUserId(String variantId)
static boolean	checkIfWithPublicVariants()	The feature to support public variants can be switched off.
List<String>	getAllPublicVariantIds()	Returns public variants that are defined as public that belong to the user.
List<String>	getAllVariantIds(boolean withParentVariants)
String	getCurrentVariantId()
String	getDefaultVariantId()
static void	initWithPublicVariants(boolean withPublicVariants)	Switch on/off the feature to support public variants.
void	markVariantIdAsPublic(String variantId)
void	removeVariant(String variantId)
void	resetToDefault()
void	saveCurrentVariant()
void	saveCurrentVariantAs(String newVariantId)
void	setCurrentVariantId(String currentVariantId)
void	setDefaultVariantId(String defaultVariantId)
void	unmarkVariantIdAsPublic(String variantId)
void	update()

Methods inherited from class java.lang.Object

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

Constructor Details

UsageVariantManager

public UsageVariantManager(String serviceType,
 String serviceId,
 org.eclnt.util.extractapply.IExtractApply service)

Method Details

checkIfWithPublicVariants

public static boolean checkIfWithPublicVariants()

The feature to support public variants can be switched off.

initWithPublicVariants

public static void initWithPublicVariants(boolean withPublicVariants)

Switch on/off the feature to support public variants. Default: switched on.

getCurrentVariantId

public String getCurrentVariantId()

setCurrentVariantId

public void setCurrentVariantId(String currentVariantId)

getDefaultVariantId

public String getDefaultVariantId()

setDefaultVariantId

public void setDefaultVariantId(String defaultVariantId)

markVariantIdAsPublic

public void markVariantIdAsPublic(String variantId)

unmarkVariantIdAsPublic

public void unmarkVariantIdAsPublic(String variantId)

resetToDefault

public void resetToDefault()

getAllVariantIds

public List<String> getAllVariantIds(boolean withParentVariants)

getAllPublicVariantIds

public List<String> getAllPublicVariantIds()

Returns public variants that are defined as public that belong to the user.

saveCurrentVariant

public void saveCurrentVariant()

saveCurrentVariantAs

public void saveCurrentVariantAs(String newVariantId)

applyCurrentVariant

public void applyCurrentVariant()

removeVariant

public void removeVariant(String variantId)

activate

public void activate(boolean applyDefaultVariant)

update

public void update()

checkIfVariantContainsUserId

public boolean checkIfVariantContainsUserId(String variantId)