Package com.microstrategy.web.tasks

Interface Task

All Known Implementing Classes:

AbstractAppTask, AbstractArchitectTask, AbstractBaseTask, AbstractDataServiceTask, AbstractDrillTask, AbstractDynamicRecipientListsTask, AbstractGetGraphPropertiesTask, AbstractGetMapConfigurationTask, AbstractGridDrillTask, AbstractMobileSubscriptionTask, AbstractParseMetricTask, AbstractResultSetBinaryResultsTask, AbstractResultSetResultsTask, AbstractSaveTask, AddJoinTask, AddMDXCubesTask, AddMultiSelectedColumns, AddObjectTagTask, AddProjectDBRoleTask, AddSelectedColumn, AddTableTask, AddVisualizationTask, AndroidRWExecutionTask, AndroidSetDocSelectorElementsTask, AnswerPromptsTask, AppGetProjectsTask, AppLoginTask, ApplyRWClientManipulation, AttributeFormTask, AutoClosePromptTask, AutoMapEmmaTablesTask, BaseFolderTask, BaseUserEntityBeanTask, BeanManipulationTask, BeanTask, BinaryXMLAPITask, BlockLoaderTask, BrowseAttributeFormsTask, BrowseMDXTask, CachesUpdateTimeTask, CalculateGroupByTask, CancelSubscriptionsTask, CatalogActionTask, ChangePasswordTask, CheckLatencyTask, CheckUserPrivilegesTask, CloseSessionsTask, CloudConnectorCatalogTask, CloudConnectorGetStatusTask, ConvertToCubeTask, ConvertToFreeFormSQLTask, ConvertToQueryBuilderTask, CreateEmmaTablesTask, CreateFolderTask, CreateGroupTask, CreateIdentityTokenTask, CreateMobileConfigurationTask, CreateProjectTask, CreateQBRepIns, CreateUserTask, DataWranglerServerTask, DBPropertiesTask, DeleteDynamicRecipientListTask, DeleteMessageTask, DeleteMobileConfigurationTask, DeleteObjectTask, DeleteObjectTask, DeletePaletteTask, DeleteProjectTask, DesktopImportSaveDashboardTask, DIAutoMappingEMMASourceTable, DICancelRefineStage, DIChangeMappingEMMASourceTable, DIChangePartitionTask, DIClearDataCacheTask, DIClearDiscoverCache, DIClearRelationshipEMMASourceTable, DICreateEmmaIRRReportInstanceTask, DICreateEmmaIRRSourceTablesTask, DICreateEMMAReportInstance, DICreateEMMASourceTable, DIDataPreparationTask, DIDeleteEmmaIRRSourceTableTask, DIDetectRelationshipEMMASourceTable, DIEditEmmaIRRSourceTableTask, DIEditEMMASourceTable, DIEditRelationshipEMMASourceTable, DIGetCloudElementToken, DIGetCubeSecurityFilterTask, DIGetEmmaIRRAttributesTask, DIGetFolderContentFromRemote, DIGetFolderIDFromRemote, DIGetObjectFolder, DIGetProjectsFromRemote, DIGetScheduleStatus, DIGetSubscriptionInfo, DIImportFromCube, DIKillJobTask, DIManageHadoopGateway, DIPersistCubeConfigInfo, DIRemoveEMMASourceTable, DISaveDistributionInfo, DISaveEMMASchedule, DISendToInboxTask, DISetCubeSecurityFilterTask, DISetDataImportInfo, DISetEmmaIRRFilterTask, DISetURLWhiteListTask, DIStartOrCancelAggFilterChangeTask, DIStartRefineStage, DIToggleDatasetServeMode, DIValidateEmmaIRRAlternateSourceTask, DIValidateEmmaSourceTask, DocumentBinaryResultsTask, DocumentXMLResultsTask, DuplicateMobileConfigurationTask, DuplicateReportInstanceTask, EditConditionTask, EditCubeTask, EditFreeFormSQLTask, EditJoinTask, EditObjectTagTask, EditSelectedColumnTask, EditTableTask, ElementsBrowseTask, ExportDocumentTask, ExportReportTask, FetchSourceObjectsTask, FolderBrowseTask, GenerateJoinsTask, GetAllMapCoordinatesTask, GetArchitectProjectsTask, GetBundleDescriptorsTask, GetBundlesTask, GetCubeAttributeGroupInfoTask, GetCubeBinaryResultsTask, GetCustomConnectorTask, GetCustomDescriptorsTask, GetD3WidgetFilesListTask, GetDBInstancesTask, GetDBMSTask, GetDBObjectsTask, GetDBRolesTask, GetDescriptorsTask, GetDIExternalInfoTask, GetDimensionTask, GetDIProjectSettingsTask, GetDossierTOCAndPromptsTask, GetDRLRelatedSubscriptionsTask, GetDynamicRecipientListsTask, GetDynamicRecipientListTask, GetElementFromGraphTask, GetESRIConfigurationTask, GetESRIExtraConfigurationTask, GetESRIKMLConfigurationTask, GetFlexSettingsTask, GetGeoShapesTask, GetGoogleConfigurationTask, GetGoogleExtraConfigurationTask, GetGridFormatTask, GetGUIDsTask, GetGWAgentsTask, GetHierarchyInfoTask, GetIVEWidgetsTask, GetJDBCConnStrTask, GetLibraryWebListTask, GetLinkInfoTask, GetLocaleInfoTask, GetLogicalTableTask, GetMapBoxPolygonIDTask, GetMapConfigurationTask, GetMapCoordinates, GetMapExtraConfigurationTask, GetMapShapesTask, GetMetricDefinitionTask, GetMobileConfigurationBlockTask, GetMobileConfigurationIndexTask, GetMobileConfigurationTask, GetMobileConfigurationVersionTask, GetMobileReportsTask, GetMobileSubscriptionTask, GetMultiMapConfigurationTask, GetNamedFolderID, GetNeeFeatureFlagsTask, GetNewMobileConfigurationTask, GetObjectDetailsTask, GetObjectInBulkTask, GetObjectSubscriptionsTask, GetODBCDriversTask, GetODBCDSNsTask, GetPageByTreeTask, GetPluginsVisListTask, GetPluginVisListTask, GetProjectAttributeInfo, GetProjectDBRolesTask, GetProjectsTask, GetPromptsTask, GetQuotaTask, GetRecentSaveAsFoldersTask, GetReportGraphImageTask, GetReportGraphPropertiesTask, GetReportXDADefinitionTask, GetRWDocumentViewsTask, GetRWEmbeddedImageTask, GetRWGraphImageTask, GetRWGraphPropertiesTask, GetRWGridFormatTask, GetRWGridViewFilterTask, GetRWTransactions, GetRWTransactionSourcesTask, GetRWTransactionTargetDataset, GetSearchSuggestionsTask, GetServerInfoTask, GetServerJSONResultsTask, GetServerPropertiesTask, GetSessionStateTask, GetShapeGeoDataTask, GetShortcutsList, GetSingleDBRole, GetSubscriptionAssociatedInformationTask, GetSystemFunctionsTask, GetSystemPickerJsonTask, GetThresholdsTask, GetTransactionReportDefinition, GetTriggersTask, GetUserDICubeInfoTask, GetUserPrivilegeXmlTask, GetVersionInfo, GetVisualizationGalleryTask, GetWebServiceCatalogTask, GetWebServiceURLTask, GetXDASchemaDBRoleTask, GridLinkedDrillTask, ImportAsyncSaveRWDTask, ImportFileTask, ImportImageTask, ImportSaveRWDTask, ImportSourceObjectTask, IPhoneGetReportResultsTask, IPhoneGetRWResultsTask, IphoneGraphResultsTask, IPhoneMobileSubscribeTask, IPhoneMobileUnsubscribeTask, IPhonePreLoadRWResultsTask, IPhoneReportResultsTask, IPhoneRWResultsTask, KeepSessionAliveTask, LinkDBRToProjectTask, LoadDocLayoutTask, LoginFirstTask, LoginTask, LogoutTask, MetadataSearchTask, MobileAppLoginTask, MobileChunkedGraphResultsTask, MobileChunkedGridResultsTask, MobileChunkedRWResultsTask, MobileDeleteSubscriptionTask, MobileDuplicateMessageTask, MobileExecuteReportDSTask, MobileExecuteReportTask, MobileExecuteRWDSTask, MobileExecuteRWTask, MobileGetDevicesTask, MobileGetInboxMessageTime, MobileGetPushRegistrationStatusTask, MobileGraphResultsTask, MobileGraphXMLTask, MobileGridResultsTask, MobileHTMLGridResultsTask, MobileLoadSubscriptionTask, MobileLoginTask, MobilePollStatusTask, MobilePromptsXmlTask, MobilePushRegisterTask, MobilePushUnregisterTask, MobileRefreshSubscriptionTask, MobileRWPDFResultsTask, MobileRWResultsTask, MobileSavePropertiesTask, MobileSaveSubscriptionTask, MobileSubscriptionTask, MobileUpdateSubscriptionTask, MobileValidateMetricValueTask, ModifyChildrenTask, ModifyPrivilegesTask, ModifySecurityFilterTask, ModifySecurityRolesTask, ModifyUserTask, MojoGetCustomSortTask, MojoGetDocumentManifestTask, MojoGetNDETask, MojoGetReportWorkingSetTask, MojoRWEventsTask, MojoRWManipulationTask, NameSearchTableTask, ObjectInfoTask, OneTierRequestTask, ParseTask, ParseTask, PollEmmaStatusTask, PollStatusTask, PrivilegeCheckerTask, PublishCubeTask, QBuilderManipulationTask, ReadFileContentsTask, RecoverDataDiscoveryErrorsTask, RefreshEngineSchemaTask, RemapObjectTask, RemoveObjectFromReportTask, RemoveOrDuplicateQBReportInstanceTask, RemoveSelectedColumnTask, RemoveSelectedJoinTask, RemoveTableTask, RenameObjectTask, RenameObjectTask, ReportBinaryResultsTask, ReportDataServiceTask, ReportExecutionTask, ReportGraphDrillTask, ReportGridDrillTask, ReportSaveTask, ResultSetBeanManipulationTask, RetrieveChildrenTask, RetrievePreviewImageTask, RWBinaryExecutionTask, RWDataServiceTask, RWDrillTask, RWExecutionTask, RWLinkedDrillTask, RWManipulationTask, RWManipulationWithoutResultTask, RWOnDemandDrillTask, RWSaveSegmentTask, RWSaveTask, RWSaveThemeTask, SaveAndPublishCubeTask, SaveCustomGroupTask, SaveDBRoleTask, SaveDynamicRecipientListTask, SaveMetricDefinitionTask, SaveObjectACLTask, SavePaletteTask, SaveReportDerivedMetricTask, SaveReportXDADefinitionTask, SaveRWDocumentViewsTask, SaveRWTransactions, SaveSubscriptionTask, SaveThresholdsTask, SchemaInstanceActionTask, SchemaManipulationTask, SearchTask, ServerConnectionTask, ServersTask, SessionAliveTask, SetConditionalTransactionTask, SetCubeAttributeFormMappingTask, SetCubeMappingTask, SetDBRoleTask, SetDocSelectorElementsTask, SetDocumentZoomTask, SetPreferenceTask, SetRWUnitPropertiesTask, SetVisualizationPropertiesTask, ShortURLTask, SparkMultiPartTask, SparkTask, StorePreviewImageTask, UpdateMDXCubesTask, UpdateMobileConfigurationPropertiesTask, UpdateMobileConfigurationTask, UpdateThemeTask, UpdateWHTableTask, UploadFileTask, UploadImageTask, UserEntityInfoTask, UserServicesTask, UsherAuthenticationTask, UsherNotifyMeTask, UsherQRCodeTask, UsherRegisterUserTask, UsherRememberMeTask, ValidateDocumentLinksTask, ValidateMetricTask, ValidatePromptForTemplateTask, ValidateUsherConfigTask, ValidateWebServerConnectionTask, WebComponentTask, WebServerAdminTask, WikiScrapperTask, WriteOnlyBeanTask, XMLAPITask

public interface Task

This interface represents a Task and how it interacts in the context of the larger Task processing framework.

Since:

MicroStrategy Web 8.1.0

Method Summary

Modifier and Type	Method	Description
void	destroy()	Destroys the Task.
boolean	getCompressOutput()
java.lang.String	getID()	Returns the identifier of this Task.
TaskMetadata	getMetadata()	Returns information about this Task.
WebPrivilegesExpression	getPrivileges()	Returns a task privileges
void	init(ContainerServices containerSvcs)	Initializes the Task with the specified ContainerServices object.
TaskRequestContext	newRequestContext()	Returns a new object to hold per-request data for this Task.
void	processRequest(TaskRequestContext context, MarkupOutput markupOutput)	Deprecated. Use processRequest(TaskRequestContext, TaskOutput) instead.
void	processRequest(TaskRequestContext context, TaskOutput taskOutput)	Instructs the Task to handle the incoming request.
void	setCompressOutput(boolean newValue)
void	setID(java.lang.String id)	Sets the identifier for this Task.
void	setPrivileges(WebPrivilegesExpression value)	Sets the task privileges.

Method Detail

getID

java.lang.String getID()

Returns the identifier of this Task.

Returns:

The identifier of this Task.

setID

void setID(java.lang.String id)

Sets the identifier for this Task.

Parameters:

id - The ID to use for this Task.

init

void init(ContainerServices containerSvcs)

Initializes the Task with the specified ContainerServices object.

Parameters:

containerSvcs - The ContainerServices object.

newRequestContext

TaskRequestContext newRequestContext()

Returns a new object to hold per-request data for this Task.

Returns:

A new TaskRequestContext object for this Task.

processRequest

void processRequest(TaskRequestContext context,
                    MarkupOutput markupOutput)
             throws TaskException

Deprecated.

Use processRequest(TaskRequestContext, TaskOutput) instead.

Instructs the Task to handle the incoming request. This is suitable for the majority of Tasks. It assumes that a single content "island" is being constructed and no special handling of that content is required. Tasks that require more sophisticated handling of the generated output should choose to implement processRequest(TaskRequestContext, TaskOutput) instead. NOTE: The TaskProcessor invokes the newer TaskOutput-based version of this method in the 9.0 release. Versions prior to this release (e.g., 8.1.x) invoked this version of processRequest. As such, if your task extends one of the MicroStrategy base classes (e.g., AbstractBaseTask), it would automatically redirect calls to the newer processRequest (which takes a TaskOutput) to this version.

Parameters:

context - The TaskRequestContext object that maintains the state of the request.

markupOutput - The MarkupOutput that records the contents of the Task response.

Throws:

TaskException - If the Task was unable to satisfy the request.

See Also:

processRequest(TaskRequestContext, TaskOutput)

processRequest

void processRequest(TaskRequestContext context,
                    TaskOutput taskOutput)
             throws TaskException

Instructs the Task to handle the incoming request. This version method of the processRequest is invoked in the current TaskProcessor version. It provides more sophisticated control over content generation. MicroStrategy Task base classes (e.g., AbstractBaseTask provide a default implementation of this method which invokes the MarkupOutput-based version. Task implementors may override either version as it suits their needs.

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 - If the Task was unable to satisfy the request.

Since:

MicroStrategy Web 9.0.0

getMetadata

TaskMetadata getMetadata()

Returns information about this Task. It includes the description of the Task and any parameters which it supports.

Returns:

A TaskMetadata object for this Task.

destroy

void destroy()

Destroys the Task. This enables the Task to release any persistent data structures.

setPrivileges

void setPrivileges(WebPrivilegesExpression value)

Sets the task privileges. The privileges will be verified when the task obtains a session

Parameters:

value - The privilege expression

getPrivileges

WebPrivilegesExpression getPrivileges()

Returns a task privileges

Returns:

a task privileges

getCompressOutput

boolean getCompressOutput()

setCompressOutput

void setCompressOutput(boolean newValue)