public class

UserServicesTask

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

Class Overview

This Task returns information about all top level user groups or users/user groups matching certain name pattern in a system.

Summary

Constants
String BLK_SEARCH_RESULT
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
String PARAM_NAME_BLOCK_BEGIN
String PARAM_NAME_BLOCK_COUNT
String PARAM_NAME_NAME_WILDCARDS
String PARAM_NAME_SEARCH_PATTERN
String PARAM_NAME_TOPGROUPS_ONLY
String TASK_DESC
String USER_GROUP_SYSTEM_FOLDER_ID
[Expand]
Inherited Constants
From class com.microstrategy.web.tasks.AbstractBaseTask
Fields
protected static String BLP_ENTITY_IS_GROUP
protected static String BLP_SEARCH_RESULT_BLOCK_BEGIN
protected static String BLP_SEARCH_RESULT_BLOCK_COUNT
protected static String BLP_SEARCH_RESULT_ITEMS
protected static String BLP_SEARCH_RESULT_NAME_WILDCARDS
protected static String BLP_SEARCH_RESULT_SEARCH_PATTERN
protected static String BLP_SEARCH_RESULT_TOTAL_SIZE
protected TaskParameterMetadata blockBegin
protected TaskParameterMetadata blockCount
protected TaskParameterMetadata nameWildcards
protected TaskParameterMetadata searchPattern
protected TaskParameterMetadata topGroupsOnly
[Expand]
Inherited Fields
From class com.microstrategy.web.tasks.AbstractBaseTask
Public Constructors
UserServicesTask()
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)
WebFolder getTopUserGroups(WebIServerSession wiss, WebObjectSource wos)
void includeItemsInfo(Block result, WebFolder wf)
int includeItemsInfoNoTgOnly(Block iResult, WebFolder iWebFolder, WebIServerSession iProjectSession, String iPattern)
WebFolder searchForUsers(WebIServerSession wiss, String pattern, int blockBegin, int blockCount, boolean useWildcard)
void setSearchFolder(WebIServerSession iProjectSession, WebSearch iWebSearch)
[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_SEARCH_RESULT

Constant Value: "SearchResult"

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"

protected static final String PARAM_NAME_BLOCK_BEGIN

Constant Value: "blockBegin"

protected static final String PARAM_NAME_BLOCK_COUNT

Constant Value: "blockCount"

protected static final String PARAM_NAME_NAME_WILDCARDS

Constant Value: "nameWildcards"

protected static final String PARAM_NAME_SEARCH_PATTERN

Constant Value: "searchPattern"

protected static final String PARAM_NAME_TOPGROUPS_ONLY

Constant Value: "topGroupsOnly"

protected static final String TASK_DESC

Constant Value: "This task provides users/user groups related information services."

protected static final String USER_GROUP_SYSTEM_FOLDER_ID

Constant Value: "73F7482511D3596C60001B8F67019608"

Fields

protected static String BLP_ENTITY_IS_GROUP

protected static String BLP_SEARCH_RESULT_BLOCK_BEGIN

protected static String BLP_SEARCH_RESULT_BLOCK_COUNT

protected static String BLP_SEARCH_RESULT_ITEMS

protected static String BLP_SEARCH_RESULT_NAME_WILDCARDS

protected static String BLP_SEARCH_RESULT_SEARCH_PATTERN

protected static String BLP_SEARCH_RESULT_TOTAL_SIZE

protected TaskParameterMetadata blockBegin

protected TaskParameterMetadata blockCount

protected TaskParameterMetadata nameWildcards

protected TaskParameterMetadata searchPattern

protected TaskParameterMetadata topGroupsOnly

Public Constructors

public UserServicesTask ()

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 WebFolder getTopUserGroups (WebIServerSession wiss, WebObjectSource wos)

protected void includeItemsInfo (Block result, WebFolder wf)

protected int includeItemsInfoNoTgOnly (Block iResult, WebFolder iWebFolder, WebIServerSession iProjectSession, String iPattern)

protected WebFolder searchForUsers (WebIServerSession wiss, String pattern, int blockBegin, int blockCount, boolean useWildcard)

protected void setSearchFolder (WebIServerSession iProjectSession, WebSearch iWebSearch)