public class

GetProjectsTask

extends AbstractBaseTask
java.lang.Object
   ↳ com.microstrategy.web.tasks.AbstractBaseTask
     ↳ com.microstrategy.web.tasks.GetProjectsTask
Known Direct Subclasses

Class Overview

This Task returns a collection of projects on a web server. Receives an optional "server" argument. If specified, only the projects on that server will be returned. Errors in Intelligence Servers or clusters are ignored unless no project is found, in which case the last exception is thrown.

Summary

Constants
String NODE_DESC
String NODE_HOSTNAME
String NODE_ID
String NODE_NAME
String NODE_PORT
String NODE_PROJECT
String NODE_PROJECTS
String NODE_SERVER
String NODE_SERVERS
String NODE_SERVER_VERSION
String PARAM_NAME_APPLICATION_TYPE The application type making the request.
[Expand]
Inherited Constants
From class com.microstrategy.web.tasks.AbstractBaseTask
Fields
protected TaskParameterMetadata applicationTypeTaskParam
[Expand]
Inherited Fields
From class com.microstrategy.web.tasks.AbstractBaseTask
Public Constructors
GetProjectsTask()
Public Methods
void processRequest(TaskRequestContext context, TaskOutput taskOutput)
This Task returns a list of all projects for all Intelligence Servers that are current registered with MicroStrategy Web or just the projects defined for a specific Intelligence Server.
Protected Methods
void checkForRequiredParameters(RequestKeys requestKeys)
Checks whether all required parameters are present or not.
[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 NODE_DESC

Constant Value: "desc"

protected static final String NODE_HOSTNAME

Constant Value: "hostName"

protected static final String NODE_ID

Constant Value: "id"

protected static final String NODE_NAME

Constant Value: "name"

protected static final String NODE_PORT

Constant Value: "port"

protected static final String NODE_PROJECT

Constant Value: "project"

protected static final String NODE_PROJECTS

Constant Value: "projects"

protected static final String NODE_SERVER

Constant Value: "server"

protected static final String NODE_SERVERS

Constant Value: "servers"

protected static final String NODE_SERVER_VERSION

Constant Value: "version"

public static final String PARAM_NAME_APPLICATION_TYPE

The application type making the request.

Constant Value: "appType"

Fields

protected TaskParameterMetadata applicationTypeTaskParam

Public Constructors

public GetProjectsTask ()

Public Methods

public void processRequest (TaskRequestContext context, TaskOutput taskOutput)

This Task returns a list of all projects for all Intelligence Servers that are current registered with MicroStrategy Web or just the projects defined for a specific Intelligence Server.

Parameters
context The TaskRequestContext object that maintains the state of the request.
taskOutput The TaskOutput that records the contents of the Task response.
Throws
TaskException For any other problems.
TaskConfigurationException If there is an internal problem with the configuration of this Task.

Protected Methods

protected void checkForRequiredParameters (RequestKeys requestKeys)

Checks whether all required parameters are present or not.

Parameters
requestKeys The RequestKeys object that contains all parameters.