Package com.microstrategy.web.tasks
Class GetProjectsTask
- java.lang.Object
-
- com.microstrategy.web.tasks.AbstractBaseTask
-
- com.microstrategy.web.tasks.GetProjectsTask
-
- All Implemented Interfaces:
Task
- Direct Known Subclasses:
AppGetProjectsTask
,GetArchitectProjectsTask
public class GetProjectsTask extends AbstractBaseTask
ThisTask
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 Modifier and Type Field Description protected TaskParameterMetadata
applicationTypeTaskParam
protected static java.lang.String
NODE_ALIAS
protected static java.lang.String
NODE_DESC
protected static java.lang.String
NODE_HOSTNAME
protected static java.lang.String
NODE_ID
protected static java.lang.String
NODE_NAME
protected static java.lang.String
NODE_PORT
protected static java.lang.String
NODE_PROJECT
protected static java.lang.String
NODE_PROJECTS
protected static java.lang.String
NODE_SERVER
protected static java.lang.String
NODE_SERVER_VERSION
protected static java.lang.String
NODE_SERVERS
static java.lang.String
PARAM_NAME_APPLICATION_TYPE
The application type making the request.-
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 GetProjectsTask()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
checkForRequiredParameters(RequestKeys requestKeys)
Checks whether all required parameters are present or not.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.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
-
-
-
-
Field Detail
-
NODE_SERVERS
protected static final java.lang.String NODE_SERVERS
- See Also:
- Constant Field Values
-
NODE_SERVER
protected static final java.lang.String NODE_SERVER
- See Also:
- Constant Field Values
-
NODE_DESC
protected static final java.lang.String NODE_DESC
- See Also:
- Constant Field Values
-
NODE_NAME
protected static final java.lang.String NODE_NAME
- See Also:
- Constant Field Values
-
NODE_SERVER_VERSION
protected static final java.lang.String NODE_SERVER_VERSION
- See Also:
- Constant Field Values
-
NODE_ID
protected static final java.lang.String NODE_ID
- See Also:
- Constant Field Values
-
NODE_PROJECTS
protected static final java.lang.String NODE_PROJECTS
- See Also:
- Constant Field Values
-
NODE_PROJECT
protected static final java.lang.String NODE_PROJECT
- See Also:
- Constant Field Values
-
NODE_PORT
protected static final java.lang.String NODE_PORT
- See Also:
- Constant Field Values
-
NODE_HOSTNAME
protected static final java.lang.String NODE_HOSTNAME
- See Also:
- Constant Field Values
-
NODE_ALIAS
protected static final java.lang.String NODE_ALIAS
- See Also:
- Constant Field Values
-
PARAM_NAME_APPLICATION_TYPE
public static final java.lang.String PARAM_NAME_APPLICATION_TYPE
The application type making the request.- See Also:
EnumDSSXMLApplicationType
, Constant Field Values
-
applicationTypeTaskParam
protected TaskParameterMetadata applicationTypeTaskParam
-
-
Method Detail
-
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 interfaceTask
- Overrides:
processRequest
in classAbstractBaseTask
- Parameters:
context
- TheTaskRequestContext
object that maintains the state of the request.taskOutput
- TheTaskOutput
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)
-
checkForRequiredParameters
protected void checkForRequiredParameters(RequestKeys requestKeys) throws TaskRequestMalformedException
Description copied from class:AbstractBaseTask
Checks whether all required parameters are present or not.- Overrides:
checkForRequiredParameters
in classAbstractBaseTask
- Parameters:
requestKeys
- TheRequestKeys
object that contains all parameters.- Throws:
TaskRequestMalformedException
- If some required parameters are missing.
-
-