VirtualValueRequest Class

Spotfire 14.2 API Reference
Represents the input and result for a value in a virtual column.
Inheritance Hierarchy

SystemObject
  Spotfire.Dxp.Framework.ThreadingWorkItem
    Spotfire.Dxp.Data.VirtualColumnsVirtualValueRequest

Namespace:  Spotfire.Dxp.Data.VirtualColumns
Assembly:  Spotfire.Dxp.Data (in Spotfire.Dxp.Data.dll) Version: 64.0.19329.3263 (64.0.19329.3263)
Syntax

C#
public sealed class VirtualValueRequest : WorkItem

The VirtualValueRequest type exposes the following members.

Properties

  NameDescription
Public propertyHasImmutableResult
Gets a value indicating whether this instance has immutable result.
(Inherited from WorkItem.)
Public propertyImmutableResult
Gets the immutable result.
(Inherited from WorkItem.)
Public propertyInputValues
The data values to compute the result value for the current request from. These values are provided from the inputs of the virtual column identified by the external id, and more generally the properties, of this request. The values are ordered in the same order as the inputs were given in the input collection. If one of the inputs have been deleted an invalid value will occur in its place.
Public propertyIsCanceled
Returns true if the work item has been canceled.
(Inherited from WorkItem.)
Public propertyIsResultValid
Returns true if the work item result is valid in the live document. This will be false if the worker model changed after the work item was added to the dispatcher.
(Inherited from WorkItem.)
Public propertyModelGeneration
Gets the associated worker model generation. This can be used by the worker to cache information based on the worker model state. Should be avoided whenever possible. Caching should instead be handled via the caching behavior, the model key and item key functions of the worker factory.
(Inherited from WorkItem.)
Public propertyProperties
Gets the properties of the container that the result value is produced for.
Public propertyTag
Gets or sets a tag object. The tag object can be used to associate information with the work item.
(Inherited from WorkItem.)
Top
Methods

  NameDescription
Public methodDispose
Frees up resources.
(Inherited from WorkItem.)
Public methodEquals
Determines whether the specified obj is the same instance as the current work item.
(Inherited from WorkItem.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from WorkItem.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodPushResultHandlerTItem
Adds a result handler to the top of the stack of result handlers. The handler must call ReturnItem when it is finished with the work item.
(Inherited from WorkItem.)
Public methodReadModelTModel
Allows reading the associated worker model in a thread-safe way.
(Inherited from WorkItem.)
Public methodReturnItem
Signals that a worker or result handler is finished with the work item. The method then passes the work item to the next handler in the stack.
(Inherited from WorkItem.)
Public methodSetEmptyResult
Sets the result value of this request to an empty value.
Public methodSetImmutableResult
Sets the immutable result.
(Inherited from WorkItem.)
Public methodSetTransientEmptyResult
Sets the result value of this request to an empty value. Unlike SetEmptyResult it will be forgotten by the cache over time enabling new requests. This method is thus intended for temporary errors such as network failures etc.
Public methodSetValidResult
Sets the result value of this request to a valid value.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Version Information

Supported in: 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8, 11.7, 11.6, 11.5, 11.4
See Also

Reference