public class

UserEntityInfoTask

extends AbstractBaseTask
java.lang.Object
   ↳ com.microstrategy.web.tasks.AbstractBaseTask
     ↳ com.microstrategy.web.tasks.UserEntityInfoTask

Class Overview

This Task returns information about a user group in metadata, such as its ancestor, members, and top level groups.

Summary

Constants
String BLK_USER_ENTITY
String BLP_WEBOBJECTINFO_ABBREVIATION
String BLP_WEBOBJECTINFO_DESC
String BLP_WEBOBJECTINFO_DSSID
String BLP_WEBOBJECTINFO_NAME
String BLP_WEBOBJECTINFO_SUBTYPE
String BLP_WEBOBJECTINFO_TYPE
[Expand]
Inherited Constants
From class com.microstrategy.web.tasks.AbstractBaseTask
Fields
protected static String BLP_ENTITY_IS_GROUP
protected static String BLP_ENTITY_MEMBERS
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 blockBegin
protected TaskParameterMetadata blockCount
protected TaskParameterMetadata outputElements
protected TaskParameterMetadata userEntityID
[Expand]
Inherited Fields
From class com.microstrategy.web.tasks.AbstractBaseTask
Public Constructors
UserEntityInfoTask()
Public Methods
void processRequest(TaskRequestContext context, TaskOutput taskOutput)
The default implementation of this method of processRequest gets the Primary Content from the TaskOutput and invokes the processRequest(TaskRequestContext, MarkupOutput) version.
Protected Methods
void buildEntityInfo(WebObjectInfo object, Block woiBlock)
void checkUserPrivilege(WebIServerSession session)
WebUserEntity getUserEntity(WebIServerSession wiss, String entityID, String entityName)
void includeAncestorInfo(WebUserEntity userEntity, Block entityBlock)
void includeParentsInfo(WebUserEntity userEntity, Block entityBlock)
void includeTopGroupsInfo(Block entityBlock, WebObjectSource wos)
[Expand]
Inherited Methods
From class com.microstrategy.web.tasks.AbstractBaseTask
From class java.lang.Object
From interface com.microstrategy.web.tasks.Task

Constants

protected static final String BLK_USER_ENTITY

Constant Value: "UserEntity"

protected static final String BLP_WEBOBJECTINFO_ABBREVIATION

Constant Value: "ab"

protected static final String BLP_WEBOBJECTINFO_DESC

Constant Value: "desc"

protected static final String BLP_WEBOBJECTINFO_DSSID

Constant Value: "did"

protected static final String BLP_WEBOBJECTINFO_NAME

Constant Value: "n"

protected static final String BLP_WEBOBJECTINFO_SUBTYPE

Constant Value: "st"

protected static final String BLP_WEBOBJECTINFO_TYPE

Constant Value: "t"

Fields

protected static String BLP_ENTITY_IS_GROUP

protected static String BLP_ENTITY_MEMBERS

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 blockBegin

protected TaskParameterMetadata blockCount

protected TaskParameterMetadata outputElements

protected TaskParameterMetadata userEntityID

Public Constructors

public UserEntityInfoTask ()

Public Methods

public void processRequest (TaskRequestContext context, TaskOutput taskOutput)

The default implementation of this method of processRequest gets the Primary Content from the TaskOutput and invokes the processRequest(TaskRequestContext, MarkupOutput) version.

Parameters
context The TaskRequestContext object that maintains the state of the request.
taskOutput The TaskOutput that contains the output generated by the Task.
Throws
TaskException

Protected Methods

protected void buildEntityInfo (WebObjectInfo object, Block woiBlock)

protected void checkUserPrivilege (WebIServerSession session)

Throws
TaskException

protected WebUserEntity getUserEntity (WebIServerSession wiss, String entityID, String entityName)

protected void includeAncestorInfo (WebUserEntity userEntity, Block entityBlock)

protected void includeParentsInfo (WebUserEntity userEntity, Block entityBlock)

protected void includeTopGroupsInfo (Block entityBlock, WebObjectSource wos)