Package com.microstrategy.web.app.tasks.architect

Class GetArchitectProjectsTask

java.lang.Object

com.microstrategy.web.tasks.AbstractBaseTask

com.microstrategy.web.tasks.GetProjectsTask

com.microstrategy.web.app.tasks.architect.GetArchitectProjectsTask

All Implemented Interfaces:

Task

public class GetArchitectProjectsTask
extends GetProjectsTask

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.

Field Summary

Fields inherited from class com.microstrategy.web.tasks.GetProjectsTask

applicationTypeTaskParam, NODE_ALIAS, NODE_DESC, NODE_HOSTNAME, NODE_ID, NODE_NAME, NODE_PORT, NODE_PROJECT, NODE_PROJECTS, NODE_SERVER, NODE_SERVER_VERSION, NODE_SERVERS, PARAM_NAME_APPLICATION_TYPE

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
GetArchitectProjectsTask()

Method Summary

Modifier and Type	Method	Description
protected void	checkUserPrivilege(WebIServerSession session)	Checking user privilege for using architect functions.
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.

Methods inherited from class com.microstrategy.web.tasks.GetProjectsTask

checkForRequiredParameters

Methods inherited from class com.microstrategy.web.tasks.AbstractBaseTask

addExecFlagsParam, addJuilLayouts, addMaxWaitParam, addMaxWaitParam, addMessageIDParam, addObjectIDParam, addParameterMetadata, addParameterMetadata, addParameterMetadata, addPollingFrequencyParam, addPollingFrequencyParam, addResultFlagsParam, addSessionIDParam, addSessionStateParam, addStateIDParam, destroy, getCompressOutput, getID, getMetadata, getPrivileges, getSysDefaultPreferenceValue, init, newRequestContext, processRequest, retrieveUploadedFile, setCompressOutput, setDescription, setID, setMetadata, setPrivileges, validateContentType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GetArchitectProjectsTask

public GetArchitectProjectsTask()

Method Detail

checkUserPrivilege

protected void checkUserPrivilege(WebIServerSession session)
                           throws TaskException

Checking user privilege for using architect functions.

Throws:

TaskException

processRequest

public void processRequest(TaskRequestContext context,
                           TaskOutput taskOutput)
                    throws TaskException

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.

Specified by:

processRequest in interface Task

Overrides:

processRequest in class GetProjectsTask

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.

See Also:

Task.processRequest(TaskRequestContext, TaskOutput)