CompensableActivity Class

Reference

Definition

Namespace:: System.Activities.Statements

Assembly:: System.Activities.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

An activity that supports compensation of its child activities.

public ref class CompensableActivity sealed : System::Activities::NativeActivity<System::Activities::Statements::CompensationToken ^>

[System.Windows.Markup.ContentProperty("Body")]
public sealed class CompensableActivity : System.Activities.NativeActivity<System.Activities.Statements.CompensationToken>

[<System.Windows.Markup.ContentProperty("Body")>]
type CompensableActivity = class
    inherit NativeActivity<CompensationToken>

Public NotInheritable Class CompensableActivity
Inherits NativeActivity(Of CompensationToken)

Inheritance: Object

Activity

ActivityWithResult

Activity<TResult>

NativeActivity<CompensationToken>
CompensableActivity

Attributes: ContentPropertyAttribute

Remarks

CompensableActivity allows a developer to specify a Body activity that defines a long-running task that performs their core business logic. It also allows the developer to optionally specify a compensation and confirmation activity to schedule appropriate business logic in the event of errors or successful completion of the Body. Compensation and confirmation of a CompensableActivity is invoked by using the CompensationToken returned by the CompensableActivity. CompensationToken is an opaque, typed object returned after successful completion of a CompensableActivity activity's Body. This CompensationToken is used by the Confirm and Compensate activities to explicitly invoke confirmation and compensation of a CompensableActivity. CompensableActivity can be composed in a nested hierarchical fashion in the workflow. For more information, see Compensation Programming Model.

Constructors

CompensableActivity()

Initializes a new instance of the CompensableActivity class.

Properties

Body	Gets or sets the activity that is scheduled when the CompensableActivity executes.
CacheId	Gets the identifier of the cache that is unique within the scope of the workflow definition. (Inherited from Activity)
CancellationHandler	Gets or sets the activity that is scheduled when the activity is canceled.
CanInduceIdle	Gets or sets a value that indicates whether the activity can cause the workflow to become idle. (Inherited from NativeActivity<TResult>)
CompensationHandler	Gets or sets the activity that is scheduled when compensation is performed on the CompensableActivity.
ConfirmationHandler	Gets or sets the activity that is scheduled when confirmation is performed for this CompensableActivity.
Constraints	Gets a collection of Constraint activities that can be configured to provide validation for the Activity. (Inherited from Activity)
DisplayName	Gets or sets an optional friendly name that is used for debugging, validation, exception handling, and tracking. (Inherited from Activity)
Id	Gets an identifier that is unique in the scope of the workflow definition. (Inherited from Activity)
Implementation	The execution logic of the activity. (Inherited from NativeActivity<TResult>)
ImplementationVersion	Gets or sets the implementation version of the activity. (Inherited from NativeActivity<TResult>)
Result	Gets or sets the result argument for the Activity<TResult>. (Inherited from Activity<TResult>)
ResultType	When implemented in a derived class, gets the type of an activity OutArgument. (Inherited from ActivityWithResult)
Variables	Gets the collection of Variable objects for this CompensableActivity.

Methods

Abort(NativeActivityAbortContext)	When implemented in a derived class, takes actions in response to the activity being aborted. (Inherited from NativeActivity<TResult>)
CacheMetadata(ActivityMetadata)	Not implemented. Use CacheMetadata(NativeActivityMetadata) instead. (Inherited from NativeActivity<TResult>)
CacheMetadata(NativeActivityMetadata)	Creates and validates a description of the activity's arguments, variables, child activities, and activity delegates. (Inherited from NativeActivity<TResult>)
Cancel(NativeActivityContext)	When implemented in a derived class, runs logic to cause graceful early completion of the activity. (Inherited from NativeActivity<TResult>)
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
Execute(NativeActivityContext)	When implemented in a derived class, runs the activity's execution logic. (Inherited from NativeActivity<TResult>)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
OnCreateDynamicUpdateMap(NativeActivityUpdateMapMetadata, Activity)	Raises an event when creating a map for the dynamic update. (Inherited from NativeActivity<TResult>)
OnCreateDynamicUpdateMap(UpdateMapMetadata, Activity)	Raises an event when creating a map for the dynamic update. (Inherited from NativeActivity<TResult>)
ShouldSerializeDisplayName()	Indicates whether the DisplayName property should be serialized. (Inherited from Activity)
ToString()	Returns a String that contains the Id and DisplayName of the Activity. (Inherited from Activity)
UpdateInstance(NativeActivityUpdateContext)	Updates the instance of NativeActivity<TResult>. (Inherited from NativeActivity<TResult>)

Applies to

Jaa