Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / EnsLib.Workflow.TaskRequest
Private  Storage   

EnsLib.Workflow.TaskRequest


persistent class EnsLib.Workflow.TaskRequest extends
Ens.Request

A task is a specialized request for a user action (it is used as part of a Workflow application).

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 11 1


Summary


Properties
%Actions %Command %FormFields %FormTemplate %FormValues
%Message %Priority %Subject %TaskHandler %Title
%UserName

Methods
%AddToSaveSet %AddToSyncSet %BMEBuilt %BuildIndicesAsync
%BuildIndicesAsyncResponse %CheckConstraints %CheckConstraintsForExtent %ClassIsLatestVersion
%ClassName %CompareContents %ComposeOid %ConstructClone
%Delete %DeleteExtent %DeleteId %DispatchClassMethod
%DispatchGetModified %DispatchGetProperty %DispatchMethod %DispatchSetModified
%DispatchSetMultidimProperty %DispatchSetProperty %DrawHTMLForm %DrawHTMLTable
%Exists %ExistsId %Extends %GUID
%GUIDSet %GetContentType %GetLock %GetParameter
%GetSwizzleObject %Id %InsertBatch %IsA
%IsModified %IsNull %KillExtent %KillExtentData
%LoadFromMemory %LockExtent %LockId %New
%NormalizeObject %ObjectIsNull %ObjectModified %Oid
%OnBeforeAddToSync %OnDetermineClass %OnTimeout %Open
%OpenId %OriginalNamespace %PackageName %PhysicalAddress
%ProcessSubmit %PurgeIndices %Reload %RemoveFromSaveSet
%ResolveConcurrencyConflict %RollBack %Save %SaveDirect
%SaveIndices %SerializeObject %SetModified %ShowContents
%ShowContentsHead %SortBegin %SortEnd %SyncObjectIn
%SyncTransport %UnlockExtent %UnlockId %ValidateIndices
%ValidateObject GetStatsDimension NewResponse XMLDTD
XMLExport XMLExportToStream XMLExportToString XMLNew
XMLSchema XMLSchemaNamespace XMLSchemaType

Subclasses
EnsLib.Background.Workflow.ExportRequest

Parameters


• parameter DOMAIN = "Ensemble";
Use our own domain for localization
• parameter RESPONSECLASSNAME = "EnsLib.Workflow.TaskResponse";
Default response class for TaskRequest is TaskResponse.

Properties


• property %Actions as %String(MAXLEN=255);
(Optional) Comma-delimited list of Actions defined for this response. This list defines what Action buttons are displayed when a User reviews a Task.
• property %Command as %String(MAXLEN=255);
(Optional) Command string to be passed to the Task Handler. Interpretation of this is up to the TaskHandler class used.
• property %FormFields as %String(MAXLEN=2000);
(Optional) Comma-separated list of fields that should appear in the form associated with this Task.
• property %FormTemplate as %String(MAXLEN=255);
(Optional) Name of csp page that provides the form template for this task;
• property %FormValues as array of %String(MAXLEN="") [ SqlFieldName = FormValues ];
(Optional) Collection of values to display within the form displayed for this task.
• property %Message as %String(MAXLEN=2000);
(Optional) Detailed message body for this task.
This is displayed when a User views details for a Task.
• property %Priority as %Integer [ InitialExpression = 3 ];
Priority of the requested Task: 1 is highest. This is used to sort items within a User's Worklist.
• property %Subject as %String(MAXLEN=255);
(Optional) Short summary of this task.
This is displayed in a User's Worklist.
• property %TaskHandler as %String(MAXLEN=128);
(Optional) Name of response class (must be a subclass of EnsLib.Workflow.TaskResponse) that is used to manage the distribution of this task. It is also used as the response type for this request.
• property %Title as %String(MAXLEN=128);
(Optional) The name of the title within the given that is preferred for handling this task. Whether or not this user actually is assigned to the task depends on how the distribution strategy used for this task.
• property %UserName as %String(MAXLEN=128);
(Optional) The name of the user that is preferred for handling this task. Whether or not this user actually is assigned to the task depends on how the distribution strategy used for this task.

Methods


• method %OnTimeout() as %Status
This method is called when this message has timed out.