public interface

EnumUserEntityBeanEvents

implements EnumEditableObjectBeanEvents
com.microstrategy.web.beans.EnumUserEntityBeanEvents
Known Indirect Subclasses

Class Overview

This interface defines all events ID and arguments for UserEntityBean

Summary

Constants
String ARGUMENT_SUB_VALUE_DELIMITER Constant for a delimiter which will be used to separate the sub values in a value string.
String ARGUMENT_SUB_VALUE_SECURITY_FILTER_DELIMITER Constant for a delimiter which will be used to separate the sub values in a value securityFilter string of the modifySecFilter task.
String ARGUMENT_VALUE_NO Constant value means FALSE for any boolean type argument.
String ARGUMENT_VALUE_YES Constant value means TRUE for any boolean type argument.
int USER_ENTITY_EVENT_ARGUMENT_DESC Argument ID for description.
int USER_ENTITY_EVENT_ARGUMENT_FULL_NAME Argument ID for full name.
int USER_ENTITY_EVENT_ARGUMENT_LDAPDN Argument ID for LDAPDN.
int USER_ENTITY_EVENT_ARGUMENT_PARENTS Argument ID for parent groups.
int USER_ENTITY_EVENT_ARGUMENT_PRIVILEGE
int USER_ENTITY_EVENT_ARGUMENT_PRIVILEGES_CATS Argument ID for privilege categories.
int USER_ENTITY_EVENT_ARGUMENT_QUOTAS Argument ID for quota setting values of all projects for current user
int USER_ENTITY_EVENT_ARGUMENT_SAVE_NOW Argument ID for saving immediately or not.
int USER_ENTITY_EVENT_ARGUMENT_SEC_FILTERS Argument ID for security filters.
int USER_ENTITY_EVENT_ARGUMENT_SEC_ROLES Argument ID for security roles.
int USER_ENTITY_EVENT_ARGUMENT_SSO
int USER_ENTITY_EVENT_DELETE Event for deleting current user.
int USER_ENTITY_EVENT_DUPLICATE Event for duplicating current user and refrencing to the duplicated user.
int USER_ENTITY_EVENT_INIT_AS_NEW Event for creating a new user.
int USER_ENTITY_EVENT_MODIFY_ALL This event includes all other modification events listed above.
int USER_ENTITY_EVENT_MODIFY_ANALYSIS_QUOTAS This event indicates the modification on user analysis quota
int USER_ENTITY_EVENT_MODIFY_AUTH Event for modifying authentication information of an account.
int USER_ENTITY_EVENT_MODIFY_BASIC Event for modifying basic information of an account.
int USER_ENTITY_EVENT_MODIFY_PARENTS Event for modifying parent groups information.
int USER_ENTITY_EVENT_MODIFY_PRIVILEGES Event for modifying privileges and security roles.
int USER_ENTITY_EVENT_MODIFY_PRIVILEGES_ONLY Event for modifying privileges.
int USER_ENTITY_EVENT_MODIFY_SECURITY_FILTER Event for modifying security filters.
int USER_ENTITY_EVENT_MODIFY_SECURITY_ROLES Event for modifying security roles.
String USER_ENTITY_EVENT_PRIVILEGES_CAT_SET Constant for a string means the whole privilege category need to be set.
String USER_ENTITY_EVENT_PRIVILEGES_CAT_TYPE_PREFIX Constant for the prefix for the sub value of a privilege category type.
int USER_ENTITY_EVENT_REFRESH Event for refreshing current user.
int USER_ENTITY_EVENT_SAVE Event for saving current user.
[Expand]
Inherited Constants
From interface com.microstrategy.web.beans.EnumEditableObjectBeanEvents
From interface com.microstrategy.web.beans.EnumObjectBeanEvents

Constants

public static final String ARGUMENT_SUB_VALUE_DELIMITER

Constant for a delimiter which will be used to separate the sub values in a value string.

Constant Value: ""

public static final String ARGUMENT_SUB_VALUE_SECURITY_FILTER_DELIMITER

Constant for a delimiter which will be used to separate the sub values in a value securityFilter string of the modifySecFilter task.

Constant Value: ";"

public static final String ARGUMENT_VALUE_NO

Constant value means FALSE for any boolean type argument.

Constant Value: "0"

public static final String ARGUMENT_VALUE_YES

Constant value means TRUE for any boolean type argument.

Constant Value: "1"

public static final int USER_ENTITY_EVENT_ARGUMENT_DESC

Argument ID for description. The value for this argument is a String of account's description.

Constant Value: 32768002 (0x01f40002)

public static final int USER_ENTITY_EVENT_ARGUMENT_FULL_NAME

Argument ID for full name. The value for this argument is a String of account's full name.

Constant Value: 32768001 (0x01f40001)

public static final int USER_ENTITY_EVENT_ARGUMENT_LDAPDN

Argument ID for LDAPDN. The value for this argument is a String of account's LDAPDN.

Constant Value: 32768003 (0x01f40003)

public static final int USER_ENTITY_EVENT_ARGUMENT_PARENTS

Argument ID for parent groups. This argument contains multiple values. One value for each parent. Should contain all parents into this argument. Any current parent missing from this argument means that parent has been removed. For each individual value, it contains the parent DSSID.

Constant Value: 32768006 (0x01f40006)

public static final int USER_ENTITY_EVENT_ARGUMENT_PRIVILEGE

Constant Value: 32768009 (0x01f40009)

public static final int USER_ENTITY_EVENT_ARGUMENT_PRIVILEGES_CATS

Argument ID for privilege categories. This argument contains multiple values. One value for each privilege category. Each value will contain these information:

  • category type appeared as USER_ENTITY_EVENT_PRIVILEGES_CAT_TYPE_PREFIX followed by the category type (refer to types in PrivilegeCategories.xml)
  • whether the whole category is set. When the whole category is set, USER_ENTITY_EVENT_PRIVILEGES_CAT_SET will be appeared as one sub value. When the whole category is not set, it will not present.
  • the individual privilege types (when the whole category is set, this part is redundant, will be ignored)
The prefixed category type, USER_ENTITY_EVENT_PRIVILEGES_CAT_SET (if appears) and each individual privilege type should be separated by ARGUMENT_SUB_VALUE_DELIMITER. For information about privilege types in a certain category, please refer to PrivilegeCategories.xml. For the meaning of each privilege, please refer to EnumDSSXMLPrivilegeTypes.

Constant Value: 32768007 (0x01f40007)

public static final int USER_ENTITY_EVENT_ARGUMENT_QUOTAS

Argument ID for quota setting values of all projects for current user

Constant Value: 32768011 (0x01f4000b)

public static final int USER_ENTITY_EVENT_ARGUMENT_SAVE_NOW

Argument ID for saving immediately or not. If saving the account information to Intelligence Server is required after processing the event handling, should include this argument in the event and put the value as ARGUMENT_VALUE_YES. Missing this argument or a value of ARGUMENT_VALUE_NO mean to not save the changed account information back to Intelligence Server. The only exception is security roles. Any changes for security roles will be saved to Intelligence Server immediately.

Constant Value: 32768008 (0x01f40008)

public static final int USER_ENTITY_EVENT_ARGUMENT_SEC_FILTERS

Argument ID for security filters. This argument contains multiple values. One value for one project. Should contain all projects into this argument. Any project missing from this argument means that there will be no security filter set for that project. For each individual value, it contains two pieces of information: project DSSID and security filter DSSID. The string representation of each individual value is project DSSID followed by ARGUMENT_SUB_VALUE_DELIMITER, followed by security filter DSSID.

Constant Value: 32768005 (0x01f40005)

public static final int USER_ENTITY_EVENT_ARGUMENT_SEC_ROLES

Argument ID for security roles. This argument contains multiple values. One value for one project. Should contain all projects into this argument. Any project missing from this argument means that there will be no security role set for that project. For each individual value, it contains two pieces of information: project DSSID and security role DSSID. The string representation of each individual value is project DSSID followed by ARGUMENT_SUB_VALUE_DELIMITER, followed by a list of security role DSSIDs (individual DSSID values are demilited by the ARGUMENT_SUB_VALUE_DELIMITER).

Constant Value: 32768004 (0x01f40004)

public static final int USER_ENTITY_EVENT_ARGUMENT_SSO

Constant Value: 32768010 (0x01f4000a)

public static final int USER_ENTITY_EVENT_DELETE

Event for deleting current user. No parameter.

Constant Value: 32768006 (0x01f40006)

public static final int USER_ENTITY_EVENT_DUPLICATE

Event for duplicating current user and refrencing to the duplicated user. No parameter.

Constant Value: 32768009 (0x01f40009)

public static final int USER_ENTITY_EVENT_INIT_AS_NEW

Event for creating a new user. No parameter.

Constant Value: 32768008 (0x01f40008)

public static final int USER_ENTITY_EVENT_MODIFY_ALL

This event includes all other modification events listed above.

Constant Value: 32768013 (0x01f4000d)

public static final int USER_ENTITY_EVENT_MODIFY_ANALYSIS_QUOTAS

This event indicates the modification on user analysis quota

Constant Value: 32768014 (0x01f4000e)

public static final int USER_ENTITY_EVENT_MODIFY_AUTH

Event for modifying authentication information of an account. The possible parameters can be sent in are:

These parameters are optional, any missing parameter means no change to that part of information. These are common parameters can be sent for both UserBean and UserGroupBean. There may be additonal parameters can be sent. Please check EnumUserBeanEvents and EnumGroupBeanEvents for additional parameters.

Constant Value: 32768002 (0x01f40002)

public static final int USER_ENTITY_EVENT_MODIFY_BASIC

Event for modifying basic information of an account. The possible parameters can be sent in are:

These parameters are optional, any missing parameter means no change to that part of information. These are common parameters can be sent for both UserBean and UserGroupBean. There may be additonal parameters can be sent. Please check EnumUserBeanEvents and EnumGroupBeanEvents for additional parameters.

Constant Value: 32768001 (0x01f40001)

public static final int USER_ENTITY_EVENT_MODIFY_PARENTS

Event for modifying parent groups information. These parameters are REQUIRED for this event. Any parameter missing means to reset that part of information to be not set at all.

These are the optional parameter(s):

Constant Value: 32768005 (0x01f40005)

public static final int USER_ENTITY_EVENT_MODIFY_PRIVILEGES

Event for modifying privileges and security roles. These parameters are REQUIRED for this event. Any parameter missing means to reset that part of information to be not set at all.

Constant Value: 32768003 (0x01f40003)

public static final int USER_ENTITY_EVENT_MODIFY_PRIVILEGES_ONLY

Event for modifying privileges. These parameters are REQUIRED for this event. Any parameter missing means to reset that part of information to be not set at all.

Constant Value: 32768011 (0x01f4000b)

public static final int USER_ENTITY_EVENT_MODIFY_SECURITY_FILTER

Event for modifying security filters. These parameters are REQUIRED for this event. Any parameter missing means to reset that part of information to be not set at all.

These are the optional parameter(s):

Constant Value: 32768004 (0x01f40004)

public static final int USER_ENTITY_EVENT_MODIFY_SECURITY_ROLES

Event for modifying security roles. These parameters are REQUIRED for this event. Any parameter missing means to reset that part of information to be not set at all.

Constant Value: 32768012 (0x01f4000c)

public static final String USER_ENTITY_EVENT_PRIVILEGES_CAT_SET

Constant for a string means the whole privilege category need to be set.

Constant Value: "ALL"

public static final String USER_ENTITY_EVENT_PRIVILEGES_CAT_TYPE_PREFIX

Constant for the prefix for the sub value of a privilege category type. This way the category type will not be confused with privilege types, which is also integers.

Constant Value: "Ctype_"

public static final int USER_ENTITY_EVENT_REFRESH

Event for refreshing current user. No parameter.

Constant Value: 32678010 (0x01f2a07a)

public static final int USER_ENTITY_EVENT_SAVE

Event for saving current user. No parameter.

Constant Value: 32768007 (0x01f40007)