Events reference: com.microstrategy.web.beans.UserGroupBean

Supported Bean: UserGroupBean

This interface represents a group user. Besides the basic funtionalities in UserEntityBean, it has the funtionalities of retrieving its children users and expand/collapse itself.

Event handler: com.microstrategy.web.beans.EnumEventHandlerTypes.HANDLER_TYPE_GROUP (8192)

Event handler that can be associated with a Group Bean.

Events

delete, delete, duplicate, duplicate, expand, initAsNew, initAsNew, modifyAnalysisQuotas, modifyAuthentication, modifyBasicInfo, modifyChildren, modifyParents, modifyPrivileges, modifyPrivilegesOnly, modifySecurityFilters, modifySecurityRoles, refresh, refresh, retrieveChildrenBlock, save, save, setName

delete
Event for deleting current user. No parameter.			1048576001	EnumEditableObjectBeanEvents.EDITABLE_OBJECT_EVENT_DELETE
delete
Event for deleting current user. No parameter.			32768006	EnumUserEntityBeanEvents.USER_ENTITY_EVENT_DELETE
duplicate
Event for duplicating current user and refrencing to the duplicated user. No parameter.			1048576004	EnumEditableObjectBeanEvents.EDITABLE_OBJECT_EVENT_DUPLICATE
duplicate
Event for duplicating current user and refrencing to the duplicated user. No parameter.			32768009	EnumUserEntityBeanEvents.USER_ENTITY_EVENT_DUPLICATE
expand
Event for expand current collection and retrieve children information. If `EnumGroupBeanEvents.GROUP_ARGUMENT_EXPAND` is omitted, collapse is assumed.			8192003	EnumGroupBeanEvents.GROUP_EVENT_EXPAND
	*expand	Argument ID for expanding. The value for this argument is `EnumUserEntityBeanEvents.ARGUMENT_VALUE_YES` for expanding, `EnumUserEntityBeanEvents.ARGUMENT_VALUE_NO` for collapsing. If the parameter is missing, means collapsing.	8192003	EnumGroupBeanEvents.GROUP_ARGUMENT_EXPAND
	saveNow	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 `EnumUserEntityBeanEvents.ARGUMENT_VALUE_YES`. Missing this argument or a value of `EnumUserEntityBeanEvents.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.	32768008	EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_SAVE_NOW
initAsNew
Event for creating a new user. No parameter.			1048576003	EnumEditableObjectBeanEvents.EDITABLE_OBJECT_EVENT_INIT_AS_NEW
	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.	32768006	EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_PARENTS
initAsNew
Event for creating a new user. No parameter.			32768008	EnumUserEntityBeanEvents.USER_ENTITY_EVENT_INIT_AS_NEW
	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.	32768006	EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_PARENTS
modifyAnalysisQuotas
This event indicates the modification on user analysis quota			32768014	EnumUserEntityBeanEvents.USER_ENTITY_EVENT_MODIFY_ANALYSIS_QUOTAS
	quotas	Argument ID for quota setting values of all projects for current user	32768011	EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_QUOTAS
modifyAuthentication
Event for modifying authentication information of an account. The possible parameters can be sent in are: `EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_LDAPDN` `EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_SAVE_NOW` 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.			32768002	EnumUserEntityBeanEvents.USER_ENTITY_EVENT_MODIFY_AUTH
	LDAPDN	Argument ID for LDAPDN. The value for this argument is a String of account's LDAPDN.	32768003	EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_LDAPDN
	saveNow	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 `EnumUserEntityBeanEvents.ARGUMENT_VALUE_YES`. Missing this argument or a value of `EnumUserEntityBeanEvents.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.	32768008	EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_SAVE_NOW
modifyBasicInfo
Event for modifying basic information of an account. The possible parameters can be sent in are: `EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_FULL_NAME` `EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_DESC` `EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_SAVE_NOW` 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.			32768001	EnumUserEntityBeanEvents.USER_ENTITY_EVENT_MODIFY_BASIC
	*fullName	Argument ID for full name. The value for this argument is a String of account's full name.	32768001	EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_FULL_NAME
	description	Argument ID for description. The value for this argument is a String of account's description.	32768002	EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_DESC
	saveNow	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 `EnumUserEntityBeanEvents.ARGUMENT_VALUE_YES`. Missing this argument or a value of `EnumUserEntityBeanEvents.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.	32768008	EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_SAVE_NOW
modifyChildren
Event for modifying children collection. If `EnumGroupBeanEvents.GROUP_EVENT_ARGUMENT_CHILDREN` is missing, that means the children collection will be reset to empty.			8192001	EnumGroupBeanEvents.GROUP_EVENT_MODIFY_CHILDREN
	*children	Argument ID for children collection. This argument contains multiple values. Each value contains child DSSID and its subtype (`EnumDSSXMLObjectSubTypes`), separated by `EnumUserEntityBeanEvents.ARGUMENT_SUB_VALUE_DELIMITER`.	8192001	EnumGroupBeanEvents.GROUP_EVENT_ARGUMENT_CHILDREN
	saveNow	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 `EnumUserEntityBeanEvents.ARGUMENT_VALUE_YES`. Missing this argument or a value of `EnumUserEntityBeanEvents.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.	32768008	EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_SAVE_NOW
modifyParents
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. `EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_PARENTS` These are the optional parameter(s): `EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_SAVE_NOW`			32768005	EnumUserEntityBeanEvents.USER_ENTITY_EVENT_MODIFY_PARENTS
	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.	32768006	EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_PARENTS
	saveNow	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 `EnumUserEntityBeanEvents.ARGUMENT_VALUE_YES`. Missing this argument or a value of `EnumUserEntityBeanEvents.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.	32768008	EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_SAVE_NOW
modifyPrivileges
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. `EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_SEC_ROLES` `EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_PRIVILEGES_CATS` `EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_SAVE_NOW`			32768003	EnumUserEntityBeanEvents.USER_ENTITY_EVENT_MODIFY_PRIVILEGES
	privId		32768009	EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_PRIVILEGE
	privilegeCategories	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 `EnumUserEntityBeanEvents.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, `EnumUserEntityBeanEvents.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, `EnumUserEntityBeanEvents.USER_ENTITY_EVENT_PRIVILEGES_CAT_SET` (if appears) and each individual privilege type should be separated by `EnumUserEntityBeanEvents.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`.	32768007	EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_PRIVILEGES_CATS
	saveNow	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 `EnumUserEntityBeanEvents.ARGUMENT_VALUE_YES`. Missing this argument or a value of `EnumUserEntityBeanEvents.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.	32768008	EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_SAVE_NOW
	securityRoles	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 `EnumUserEntityBeanEvents.ARGUMENT_SUB_VALUE_DELIMITER`, followed by a list of security role DSSIDs (individual DSSID values are demilited by the `EnumUserEntityBeanEvents.ARGUMENT_SUB_VALUE_DELIMITER`).	32768004	EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_SEC_ROLES
modifyPrivilegesOnly
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. `EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_PRIVILEGES_CATS` `EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_SAVE_NOW`			32768011	EnumUserEntityBeanEvents.USER_ENTITY_EVENT_MODIFY_PRIVILEGES_ONLY
	privId		32768009	EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_PRIVILEGE
	privilegeCategories	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 `EnumUserEntityBeanEvents.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, `EnumUserEntityBeanEvents.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, `EnumUserEntityBeanEvents.USER_ENTITY_EVENT_PRIVILEGES_CAT_SET` (if appears) and each individual privilege type should be separated by `EnumUserEntityBeanEvents.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`.	32768007	EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_PRIVILEGES_CATS
	saveNow	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 `EnumUserEntityBeanEvents.ARGUMENT_VALUE_YES`. Missing this argument or a value of `EnumUserEntityBeanEvents.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.	32768008	EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_SAVE_NOW
modifySecurityFilters
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. `EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_SEC_FILTERS` These are the optional parameter(s): `EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_SAVE_NOW`			32768004	EnumUserEntityBeanEvents.USER_ENTITY_EVENT_MODIFY_SECURITY_FILTER
	saveNow	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 `EnumUserEntityBeanEvents.ARGUMENT_VALUE_YES`. Missing this argument or a value of `EnumUserEntityBeanEvents.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.	32768008	EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_SAVE_NOW
	securityFilters	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 `EnumUserEntityBeanEvents.ARGUMENT_SUB_VALUE_DELIMITER`, followed by security filter DSSID.	32768005	EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_SEC_FILTERS
modifySecurityRoles
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. `EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_SEC_ROLES` `EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_SAVE_NOW`			32768012	EnumUserEntityBeanEvents.USER_ENTITY_EVENT_MODIFY_SECURITY_ROLES
	saveNow	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 `EnumUserEntityBeanEvents.ARGUMENT_VALUE_YES`. Missing this argument or a value of `EnumUserEntityBeanEvents.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.	32768008	EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_SAVE_NOW
	securityRoles	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 `EnumUserEntityBeanEvents.ARGUMENT_SUB_VALUE_DELIMITER`, followed by a list of security role DSSIDs (individual DSSID values are demilited by the `EnumUserEntityBeanEvents.ARGUMENT_SUB_VALUE_DELIMITER`).	32768004	EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_SEC_ROLES
refresh
Event for refreshing current user. No parameter.			1048576005	EnumEditableObjectBeanEvents.EDITABLE_OBJECT_EVENT_REFRESH
refresh
			32768010
retrieveChildrenBlock
Event for incremental fetching a block of children collection.			8192002	EnumGroupBeanEvents.GROUP_EVENT_RETRIEVE_CHILDREN_BLOCK
	*blockBegin	Argument ID for block begin that is used for retrieving partial children collection.	8192004	EnumGroupBeanEvents.GROUP_EVENT_ARGUMENT_BLOCK_BEGIN
	*direction	Argument ID for block direction used for retrieving partial children collection. The possible values for this argument are `Scrollable.NEXT_BLOCK` or `Scrollable.PREVIOUS_BLOCK`	8192002	EnumGroupBeanEvents.GROUP_EVENT_ARGUMENT_BLOCK_DIRECTION
save
Event for saving current user. No parameter.			1048576002	EnumEditableObjectBeanEvents.EDITABLE_OBJECT_EVENT_SAVE
save
Event for saving current user. No parameter.			32768007	EnumUserEntityBeanEvents.USER_ENTITY_EVENT_SAVE
setName
Event for setting a new name for the object.			1048576006	EnumEditableObjectBeanEvents.EDITABLE_OBJECT_EVENT_SET_NAME
	name		1048576001	EnumEditableObjectBeanEvents.EDITABLE_OBJECT_ARGUMENT_NAME

Notes

* denotes required field.