Package de.elo.ix.client

Class UserProductFeatures

java.lang.Object

de.elo.ix.client.UserProductFeatures

public class UserProductFeatures
extends Object

The class UserProductFeatures is used to define product features that are allowed or enabled for a user.

Since:

25.00.000.000

Field Summary

Fields

Modifier and Type	Field	Description
protected UserProductClientType	allowedClientType	Defines the type of the client software the user is allowed to use.
protected List<UserProductClientType>	allowedClientTypes	Read-only list of client types that are effective for the user or group.
static final String	USER_TYPE_KEY

Constructor Summary

Constructors

Constructor	Description
UserProductFeatures()
UserProductFeatures(int userClientType)
UserProductFeatures(UserProductClientType userClientType)

Method Summary

Modifier and Type	Method	Description
void	addAllowedClientType(int userClientType)
void	addAllowedClientType(UserProductClientType allowedClientType)
void	addAllowedClientType(Set<UserProductClientType> allowedClientTypes)
UserProductClientType	getAllowedClientType()
List<UserProductClientType>	getAllowedClientTypes()
void	setAllowedClientType(UserProductClientType allowedClientType)	Sets the value of allowedClientType
void	setAllowedClientTypes(List<UserProductClientType> allowedClientTypes)	Sets the list of effective client types for the user or group.

Methods inherited from class java.lang.Object

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

Field Details

USER_TYPE_KEY

public static final String USER_TYPE_KEY

See Also:

• Constant Field Values

allowedClientType

protected UserProductClientType allowedClientType

Defines the type of the client software the user is allowed to use.

When writing the user data you can directly assign a UserProductClientType value to this property. This property must not be null. In case of uncertainty use UserProductClientType.DEFAULT. Accordingly, when reading the user data, this field will always be not null.

You can assign a non-default value to this property for users as well as groups with different effects. For users, a non default setting will directly consume a license according to the type. For groups, the setting does not consume a license but the setting will be handed down to the users of the group and therefore consumes a license for every user that is in this group. The procedure works recursively for subgroups. If a user is member of multiple groups with different client types, all of them will be counted. You can find the effective client types in the field allowedClientTypes.

allowedClientTypes

protected List<UserProductClientType> allowedClientTypes

Read-only list of client types that are effective for the user or group.

This list is calculated by the server and contains the inherited client types from all groups the user is member of. Additionally, this list contains the own client type of the user according to allowedClientType. This list is always not null and contains at least the value of allowedClientType. The list does not contain duplicate values, the sort order is not defined.

Constructor Details

UserProductFeatures

public UserProductFeatures()

UserProductFeatures

public UserProductFeatures(int userClientType)

UserProductFeatures

public UserProductFeatures(UserProductClientType userClientType)

Method Details

getAllowedClientType

public UserProductClientType getAllowedClientType()

Returns:

the value of allowedClientType

setAllowedClientType

public void setAllowedClientType(UserProductClientType allowedClientType)

Sets the value of allowedClientType

Parameters:

allowedClientType - UserProductClientType value to set

getAllowedClientTypes

public List<UserProductClientType> getAllowedClientTypes()

Returns:

the list of effective client types for the user or group.

See Also:

• allowedClientTypes

setAllowedClientTypes

public void setAllowedClientTypes(List<UserProductClientType> allowedClientTypes)

Sets the list of effective client types for the user or group. This method is intended to be used by the server. Setting this property on the client side does not have any effect on the server.

Parameters:

allowedClientTypes - list of UserProductClientType values to set.

addAllowedClientType

public void addAllowedClientType(Set<UserProductClientType> allowedClientTypes)

addAllowedClientType

public void addAllowedClientType(UserProductClientType allowedClientType)

addAllowedClientType

public void addAllowedClientType(int userClientType)