Package com.microstrategy.web.tasks
Class UserEntityInfoTask
- java.lang.Object
-
- com.microstrategy.web.tasks.AbstractBaseTask
-
- com.microstrategy.web.tasks.UserEntityInfoTask
-
- All Implemented Interfaces:
Task
public class UserEntityInfoTask extends AbstractBaseTask
ThisTask
returns information about a user group in metadata, such as its ancestor, members, and top level groups.
-
-
Field Summary
Fields Modifier and Type Field Description protected static java.lang.String
BLK_USER_ENTITY
protected TaskParameterMetadata
blockBegin
protected TaskParameterMetadata
blockCount
protected static java.lang.String
BLP_ENTITY_IS_GROUP
protected static java.lang.String
BLP_ENTITY_MEMBERS
protected static java.lang.String
BLP_WEBOBJECTINFO_ABBREVIATION
protected static java.lang.String
BLP_WEBOBJECTINFO_DESC
protected static java.lang.String
BLP_WEBOBJECTINFO_DSSID
protected static java.lang.String
BLP_WEBOBJECTINFO_NAME
protected static java.lang.String
BLP_WEBOBJECTINFO_SUBTYPE
protected static java.lang.String
BLP_WEBOBJECTINFO_TYPE
protected static int
OUTPUT_ANCESTORS
protected static int
OUTPUT_BASIC_INFO
protected static int
OUTPUT_CHILDREN_ITEMS
protected static int
OUTPUT_PARENTS
protected static int
OUTPUT_TOP_GROUPS
protected TaskParameterMetadata
outputElements
protected TaskParameterMetadata
userEntityID
-
Fields inherited from class com.microstrategy.web.tasks.AbstractBaseTask
compressOutput, CONTENT_TYPE_BINARY, CONTENT_TYPE_HTML, CONTENT_TYPE_JSON, CONTENT_TYPE_JSON_ALL, CONTENT_TYPE_JSON_D, CONTENT_TYPE_JSON_P, CONTENT_TYPE_XML, CONTENT_TYPE_XML_ANF, DEFAULT_MAX_WAIT, DEFAULT_POLLING_FREQ, execFlagsParam, INDEFINITE_MAX_WAIT, maxWaitParam, metadata, mPrivileges, msgIDParam, objectIDParam, OTHER_CONTENT_KEY_LAYOUTS, PARAM_NAME_EXEC_FLAGS, PARAM_NAME_MAX_WAIT, PARAM_NAME_MESSAGE_ID, PARAM_NAME_OBJECT_ID, PARAM_NAME_POLLING_FREQ, PARAM_NAME_RESULT_FLAGS, PARAM_NAME_SESSION_ID, PARAM_NAME_SESSION_STATE, PARAM_NAME_STATE_ID, pollingFreqParam, PREFERENCE_DEFAULT_MAX_WAIT_IN_TASK, resultFlagsParam, sessionIDParam, sessionStateParam, stateIDParam
-
-
Constructor Summary
Constructors Constructor Description UserEntityInfoTask()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
buildEntityInfo(WebObjectInfo object, Block woiBlock)
protected void
checkUserPrivilege(WebIServerSession session)
protected WebUserEntity
getUserEntity(WebIServerSession wiss, java.lang.String entityID, java.lang.String entityName)
protected void
includeAncestorInfo(WebUserEntity userEntity, Block entityBlock)
protected void
includeParentsInfo(WebUserEntity userEntity, Block entityBlock)
protected void
includeTopGroupsInfo(Block entityBlock, WebObjectSource wos)
void
processRequest(TaskRequestContext context, TaskOutput taskOutput)
The default implementation of this method of processRequest gets the Primary Content from the TaskOutput and invokes theAbstractBaseTask.processRequest(TaskRequestContext, MarkupOutput)
version.-
Methods inherited from class com.microstrategy.web.tasks.AbstractBaseTask
addExecFlagsParam, addJuilLayouts, addMaxWaitParam, addMaxWaitParam, addMessageIDParam, addObjectIDParam, addParameterMetadata, addParameterMetadata, addParameterMetadata, addPollingFrequencyParam, addPollingFrequencyParam, addResultFlagsParam, addSessionIDParam, addSessionStateParam, addStateIDParam, checkForRequiredParameters, destroy, getCompressOutput, getID, getMetadata, getPrivileges, getSysDefaultPreferenceValue, init, newRequestContext, processRequest, retrieveUploadedFile, setCompressOutput, setDescription, setID, setMetadata, setPrivileges, validateContentType
-
-
-
-
Field Detail
-
BLK_USER_ENTITY
protected static final java.lang.String BLK_USER_ENTITY
- See Also:
- Constant Field Values
-
BLP_ENTITY_IS_GROUP
protected static java.lang.String BLP_ENTITY_IS_GROUP
-
BLP_ENTITY_MEMBERS
protected static java.lang.String BLP_ENTITY_MEMBERS
-
BLP_WEBOBJECTINFO_ABBREVIATION
protected static final java.lang.String BLP_WEBOBJECTINFO_ABBREVIATION
- See Also:
- Constant Field Values
-
BLP_WEBOBJECTINFO_DESC
protected static final java.lang.String BLP_WEBOBJECTINFO_DESC
- See Also:
- Constant Field Values
-
BLP_WEBOBJECTINFO_DSSID
protected static final java.lang.String BLP_WEBOBJECTINFO_DSSID
- See Also:
- Constant Field Values
-
BLP_WEBOBJECTINFO_NAME
protected static final java.lang.String BLP_WEBOBJECTINFO_NAME
- See Also:
- Constant Field Values
-
BLP_WEBOBJECTINFO_SUBTYPE
protected static final java.lang.String BLP_WEBOBJECTINFO_SUBTYPE
- See Also:
- Constant Field Values
-
BLP_WEBOBJECTINFO_TYPE
protected static final java.lang.String BLP_WEBOBJECTINFO_TYPE
- See Also:
- Constant Field Values
-
OUTPUT_BASIC_INFO
protected static int OUTPUT_BASIC_INFO
-
OUTPUT_CHILDREN_ITEMS
protected static int OUTPUT_CHILDREN_ITEMS
-
OUTPUT_PARENTS
protected static int OUTPUT_PARENTS
-
OUTPUT_ANCESTORS
protected static int OUTPUT_ANCESTORS
-
OUTPUT_TOP_GROUPS
protected static int OUTPUT_TOP_GROUPS
-
userEntityID
protected TaskParameterMetadata userEntityID
-
outputElements
protected TaskParameterMetadata outputElements
-
blockBegin
protected TaskParameterMetadata blockBegin
-
blockCount
protected TaskParameterMetadata blockCount
-
-
Method Detail
-
processRequest
public void processRequest(TaskRequestContext context, TaskOutput taskOutput) throws TaskException
Description copied from class:AbstractBaseTask
The default implementation of this method of processRequest gets the Primary Content from the TaskOutput and invokes theAbstractBaseTask.processRequest(TaskRequestContext, MarkupOutput)
version.- Specified by:
processRequest
in interfaceTask
- Overrides:
processRequest
in classAbstractBaseTask
- Parameters:
context
- TheTaskRequestContext
object that maintains the state of the request.taskOutput
- TheTaskOutput
that contains the output generated by the Task.- Throws:
TaskException
- If the Task was unable to satisfy the request.- See Also:
Task.processRequest(TaskRequestContext, TaskOutput)
-
getUserEntity
protected WebUserEntity getUserEntity(WebIServerSession wiss, java.lang.String entityID, java.lang.String entityName)
-
checkUserPrivilege
protected void checkUserPrivilege(WebIServerSession session) throws TaskException
- Throws:
TaskException
-
buildEntityInfo
protected void buildEntityInfo(WebObjectInfo object, Block woiBlock)
-
includeTopGroupsInfo
protected void includeTopGroupsInfo(Block entityBlock, WebObjectSource wos) throws TaskConfigurationException
- Throws:
TaskConfigurationException
-
includeParentsInfo
protected void includeParentsInfo(WebUserEntity userEntity, Block entityBlock)
-
includeAncestorInfo
protected void includeAncestorInfo(WebUserEntity userEntity, Block entityBlock) throws TaskConfigurationException
- Throws:
TaskConfigurationException
-
-